aboutsummaryrefslogtreecommitdiff
path: root/go-ipfs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'go-ipfs/README.md')
-rw-r--r--go-ipfs/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/go-ipfs/README.md b/go-ipfs/README.md
new file mode 100644
index 0000000..f541482
--- /dev/null
+++ b/go-ipfs/README.md
@@ -0,0 +1,28 @@
+# ipfs commandline tool
+
+This is the [ipfs](http://ipfs.io) commandline tool. It contains a full ipfs node.
+
+## Install
+
+To install it, move the binary somewhere in your `$PATH`:
+
+```sh
+sudo mv ipfs /usr/local/bin/ipfs
+```
+
+Or run `sudo ./install.sh` which does this for you.
+
+## Usage
+
+First, you must initialize your local ipfs node:
+
+```sh
+ipfs init
+```
+
+This will give you directions to get started with ipfs.
+You can always get help with:
+
+```sh
+ipfs --help
+```