summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoranonymous2022-09-21 12:46:08 -0400
committeranonymous2022-09-21 12:46:08 -0400
commitdd352a3a167b272ab0c2c81c9942b8a9a636944d (patch)
tree7cbc32277ba285029ab3c743b6fccb9556743752
parent25f68fec75d103044d7d72003c3fc56ddaa9ca9c (diff)
slight doc updates
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4ac0a73..c9ab192 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-# The Basic Graffiti Javascript Library
+# Graffiti for Vanilla Javascript
This is the base Javascript library that interfaces with the [Graffiti server](https://github.com/csail-graffiti/server).
-We recommend not using the vanilla library itself but instead using framework plugins built on top of this library like the [Graffiti plugin for Vue.JS](https://github.com/csail-graffiti/graffiti-js-vue).
+We recommend not using this vanilla library itself but instead using framework plugins that are built on top of it like the [Graffiti plugin for Vue.JS](https://github.com/csail-graffiti/graffiti-js-vue).
Example usage:
@@ -42,6 +42,9 @@ const myCoolPost = {
type: 'post',
content: 'hello world'
}
+// ("completing" an object annotates
+// it with your user ID and a random
+// object ID, required by the server)
gs.complete(myCoolPost)
await gs.update(myCoolPost)