Browse code

Update documentation

Jaidyn Levesque authored on 2019-06-19 17:01:18
Showing 1 changed files
... ...
@@ -1,5 +1,5 @@
1 1
 ===============================================================================
2
-CL-IPFS-API²                                   For space-orientied lisp weenies
2
+CL-IPFS-API²                                                                   
3 3
 ===============================================================================
4 4
 
5 5
 :cl-ipfs-api² is a pretty simple set of IPFS bindings for Common Lisp, using
... ...
@@ -35,14 +35,20 @@ The calls implemented so far:
35 35
 	* file, files, filestore
36 36
 	* key, name, object
37 37
 	* p2p, pin, pubsub
38
+	* refs, repo, stats
39
+	* swarm, urlstore
38 40
 	* version (version, version/deps)
39 41
 
40 42
 Some calls were skipped over, but wouldn't be hard to add:
41 43
 	* object/put, object/set-data object/patch/append-data
44
+	* tar calls were deliberately ignored (useless)
42 45
 
43 46
 Functions return either strings, lists, or associative lists, depending on
44 47
 context. All errors return two values— nil and an error message (string).
45
-Make sure to read docstrings ☆
48
+
49
+Make sure to read docstrings for specific information, and keeping the API
50
+reference handy is a good idea (/ipns/docs.ipfs.io/reference/api/http/).
51
+
46 52
 
47 53
 
48 54
 ————————————————————————————————————————