From 03260a92817c2fe8c8a328b7aa8fbae1f227bbfa Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@tremily.us>
Date: Sun, 17 May 2015 11:49:30 -0700
Subject: [PATCH] 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.
---
 namesys/interface.go | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/namesys/interface.go b/namesys/interface.go
index 4ceb3b9d9..74f686128 100644
--- a/namesys/interface.go
+++ b/namesys/interface.go
@@ -1,4 +1,32 @@
-// package namesys implements various functionality for the ipns naming system.
+/*
+Package namesys implements resolvers and publishers for the IPFS
+naming system (IPNS).
+
+The core of IPFS is an immutable, content-addressable Merkle graph.
+That works well for many use cases, but doesn't allow you to answer
+questions like "what is Alice's current homepage?".  The mutable name
+system allows Alice to publish information like:
+
+  The current homepage for alice.example.com is
+  /ipfs/Qmcqtw8FfrVSBaRmbWwHxt3AuySBhJLcvmFYi3Lbc4xnwj
+
+or:
+
+  The current homepage for node
+  QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
+  is
+  /ipfs/Qmcqtw8FfrVSBaRmbWwHxt3AuySBhJLcvmFYi3Lbc4xnwj
+
+The mutable name system also allows users to resolve those references
+to find the immutable IPFS object currently referenced by a given
+mutable name.
+
+For command-line bindings to this functionality, see:
+
+  ipfs name
+  ipfs dns
+  ipfs resolve
+*/
 package namesys
 
 import (
-- 
GitLab