update installation instructions and update usage to most recent
Jeromy committed
Dec 19, 2014 at 19:25 UTC
35e2338d65c5f155ee8ebb4da8f1c61164bd7c79
1 file changed
+36
-36
README.md
+36
-36
@@ -14,12 +14,10 @@ Please put all issues regarding go IPFS _implementation_ in [this repo](https://
14
15
## Install
16
17
-[Install Go 1.3+](http://golang.org/doc/install). Then:
17
+[Install Go 1.3+](http://golang.org/doc/install). Then simply:
18
19
```
20
-go get github.com/jbenet/go-ipfs/cmd/ipfs
21
-cd $GOPATH/src/github.com/jbenet/go-ipfs/cmd/ipfs
22
-go install
20
+go get -u github.com/jbenet/go-ipfs/cmd/ipfs
21
```
22
23
NOTES:
@@ -38,41 +36,43 @@ dependencies as well.
36
## Usage
37
38
```
41
-ipfs - global versioned p2p merkledag file system
42
-
43
-Basic commands:
44
-
45
- init Initialize ipfs local configuration.
46
- add <path> Add an object to ipfs.
47
- cat <ref> Show ipfs object data.
48
- ls <ref> List links from an object.
49
- refs <ref> List link hashes from an object.
50
-
51
-Tool commands:
52
-
53
- config Manage configuration.
54
- update Download and apply go-ipfs updates.
55
- version Show ipfs version information.
56
- commands List all available commands.
57
-
58
-Advanced Commands:
59
-
60
- mount Mount an ipfs read-only mountpoint.
61
- serve Serve an interface to ipfs.
62
- net-diag Print network diagnostic
63
-
64
-Plumbing commands:
65
-
66
- block Interact with raw blocks in the datastore
67
- object Interact with raw dag nodes
68
-
69
-
70
-Use "ipfs help <command>" for more information about a command.
39
+ ipfs - global p2p merkle-dag filesystem
40
+
41
+ ipfs [<flags>] <command> [<arg>] ...
42
+
43
+ Basic commands:
44
+
45
+ init Initialize ipfs local configuration
46
+ add <path> Add an object to ipfs
47
+ cat <ref> Show ipfs object data
48
+ ls <ref> List links from an object
49
+
50
+ Tool commands:
51
+
52
+ config Manage configuration
53
+ update Download and apply go-ipfs updates
54
+ version Show ipfs version information
55
+ commands List all available commands
56
+ id Show info about ipfs peers
57
+
58
+ Advanced Commands:
59
+
60
+ daemon Start a long-running daemon process
61
+ mount Mount an ipfs read-only mountpoint
62
+ serve Serve an interface to ipfs
63
+ diag Print diagnostics
64
+
65
+ Plumbing commands:
66
+
67
+ block Interact with raw blocks in the datastore
68
+ object Interact with raw dag nodes
69
+
70
+ Use 'ipfs <command> --help' to learn more about each command.
71
```
72
73
## Getting Started
74
To start using ipfs, you must first initialize ipfs's config files on your
75
-system, this is done with `ipfs init`. See `ipfs help init` for information on
75
+system, this is done with `ipfs init`. See `ipfs init --help` for information on
76
the optional arguments it takes. After initialization is complete, you can use
77
`ipfs mount`, `ipfs add` and any of the other commands to explore!
78
@@ -90,7 +90,7 @@ Basic proof of 'ipfs working' locally:
90
### Troubleshooting
91
If you have previously installed ipfs before and you are running into
92
problems getting a newer version to work, try deleting (or backing up somewhere
93
-else) your config directory (~/.go-ipfs by default) and rerunning `ipfs init`.
93
+else) your ipfs config directory (~/.go-ipfs by default) and rerunning `ipfs init`.
94
This will reinitialize the config file to its defaults and clear out the local
95
datastore of any bad entries.
96