readme fix
Juan Batiz-Benet committed
Jul 6, 2014 at 02:17 UTC
ac0f9b1e7dc30b82e3c9fed78b62e0d28472b2a8
2 files changed
+35
-2
README.md
+34
-1
@@ -7,4 +7,37 @@ Please put all issues regarding IPFS _design_ in the
7
8
Please put all issues regarding go IPFS _implementation_ in [this repo](https://github.com/jbenet/go-ipfs/issues).
9
10
-The [node implementation](https://github.com/jbenet/node-ipfs) is much farther along. This one is just a skeleton.
10
+## Install
11
+
12
+[Install Go](http://golang.org/doc/install). Then:
13
+
14
+```
15
+git clone https://github.com/jbenet/go-ipfs
16
+cd go-ipfs
17
+go install
18
+```
19
+
20
+## Usage
21
+
22
+```
23
+ipfs - global versioned p2p merkledag file system
24
+
25
+Basic commands:
26
+
27
+ add <path> Add an object to ipfs.
28
+ cat <ref> Show ipfs object data.
29
+ ls <ref> List links from an object.
30
+ refs <ref> List link hashes from an object.
31
+
32
+Tool commands:
33
+
34
+ config Manage configuration.
35
+ version Show ipfs version information.
36
+ commands List all available commands.
37
+
38
+Advanced Commands:
39
+
40
+ mount Mount an ipfs read-only mountpoint.
41
+
42
+Use "ipfs help <command>" for more information about a command.
43
+```
cli/ipfs.go
+1
-1
@@ -30,7 +30,7 @@ Tool commands:
30
31
Advanced Commands:
32
33
- mount Mount an ipfs a read-only mountpoint.
33
+ mount Mount an ipfs read-only mountpoint.
34
35
Use "ipfs help <command>" for more information about a command.
36
`,