summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJaidyn Levesque <jadedctrl@teknik.io>2019-06-19 17:01:18 +0000
committerJaidyn Levesque <jadedctrl@teknik.io>2019-06-19 17:01:18 +0000
commitbc9de0aae91442a294840925e731394aef5d6b0a (patch)
tree77e3a84545ff2b6d2bd8afe0a3a1e9e5aa5935dc
parented3afe6cd0ac734a0688917267db67ee8ce7a0b9 (diff)
downloadcl-ipfs-api2-bc9de0aae91442a294840925e731394aef5d6b0a.tar.bz2
cl-ipfs-api2-bc9de0aae91442a294840925e731394aef5d6b0a.zip
Update documentation
-rw-r--r--README.txt10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.txt b/README.txt
index c541915..1739a11 100644
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,5 @@
===============================================================================
-CL-IPFS-API² For space-orientied lisp weenies
+CL-IPFS-API²
===============================================================================
:cl-ipfs-api² is a pretty simple set of IPFS bindings for Common Lisp, using
@@ -35,14 +35,20 @@ The calls implemented so far:
* file, files, filestore
* key, name, object
* p2p, pin, pubsub
+ * refs, repo, stats
+ * swarm, urlstore
* version (version, version/deps)
Some calls were skipped over, but wouldn't be hard to add:
* object/put, object/set-data object/patch/append-data
+ * tar calls were deliberately ignored (useless)
Functions return either strings, lists, or associative lists, depending on
context. All errors return two values— nil and an error message (string).
-Make sure to read docstrings ☆
+
+Make sure to read docstrings for specific information, and keeping the API
+reference handy is a good idea (/ipns/docs.ipfs.io/reference/api/http/).
+
————————————————————————————————————————