diff --git a/README.md b/README.md index 24228258e5afcee6d5af2c1ed030475d4961b9b2..ed4322d04540abf56a93d36f6465d48605f5f803 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,37 @@ Please put all issues regarding IPFS _design_ in the Please put all issues regarding go IPFS _implementation_ in [this repo](https://github.com/jbenet/go-ipfs/issues). -The [node implementation](https://github.com/jbenet/node-ipfs) is much farther along. This one is just a skeleton. +## Install + +[Install Go](http://golang.org/doc/install). Then: + +``` +git clone https://github.com/jbenet/go-ipfs +cd go-ipfs +go install +``` + +## Usage + +``` +ipfs - global versioned p2p merkledag file system + +Basic commands: + + add <path> Add an object to ipfs. + cat <ref> Show ipfs object data. + ls <ref> List links from an object. + refs <ref> List link hashes from an object. + +Tool commands: + + config Manage configuration. + version Show ipfs version information. + commands List all available commands. + +Advanced Commands: + + mount Mount an ipfs read-only mountpoint. + +Use "ipfs help <command>" for more information about a command. +``` diff --git a/cli/ipfs.go b/cli/ipfs.go index dd62a4e31972b814a42efdfb0a269e9cbc064093..1fcbbf1541f0747b9e8f233daf0921783d3086a7 100644 --- a/cli/ipfs.go +++ b/cli/ipfs.go @@ -30,7 +30,7 @@ Tool commands: Advanced Commands: - mount Mount an ipfs a read-only mountpoint. + mount Mount an ipfs read-only mountpoint. Use "ipfs help <command>" for more information about a command. `,