namesys/interface: Expand package docs to discuss mutable names
What they are, why you'd use them, and which command-line tools you can use to access this functionality.
W. Trevor King committed
May 17, 2015 at 11:49 UTC
03260a92817c2fe8c8a328b7aa8fbae1f227bbfa
1 file changed
+29
-1
namesys/interface.go
+29
-1
@@ -1,4 +1,32 @@
1
-// package namesys implements various functionality for the ipns naming system.
1
+/*
2
+Package namesys implements resolvers and publishers for the IPFS
3
+naming system (IPNS).
4
+
5
+The core of IPFS is an immutable, content-addressable Merkle graph.
6
+That works well for many use cases, but doesn't allow you to answer
7
+questions like "what is Alice's current homepage?". The mutable name
8
+system allows Alice to publish information like:
9
+
10
+ The current homepage for alice.example.com is
11
+ /ipfs/Qmcqtw8FfrVSBaRmbWwHxt3AuySBhJLcvmFYi3Lbc4xnwj
12
+
13
+or:
14
+
15
+ The current homepage for node
16
+ QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
17
+ is
18
+ /ipfs/Qmcqtw8FfrVSBaRmbWwHxt3AuySBhJLcvmFYi3Lbc4xnwj
19
+
20
+The mutable name system also allows users to resolve those references
21
+to find the immutable IPFS object currently referenced by a given
22
+mutable name.
23
+
24
+For command-line bindings to this functionality, see:
25
+
26
+ ipfs name
27
+ ipfs dns
28
+ ipfs resolve
29
+*/
30
package namesys
31
32
import (