Update README.md
Update the usage output to present one.
drathir committed
Aug 25, 2015 at 15:38 UTC
a283db232836577b36ecf881af5c6137f308cc81
1 file changed
+37
-19
README.md
+37
-19
@@ -72,38 +72,56 @@ dependencies as well.
72
## Usage
73
74
```
75
+USAGE:
76
+
77
ipfs - global p2p merkle-dag filesystem
78
79
ipfs [<flags>] <command> [<arg>] ...
80
79
- Basic commands:
80
-
81
+ BASIC COMMANDS
82
+
83
init Initialize ipfs local configuration
84
add <path> Add an object to ipfs
85
cat <ref> Show ipfs object data
86
+ get <ref> Download ipfs objects
87
ls <ref> List links from an object
85
-
86
- Tool commands:
87
-
88
- config Manage configuration
89
- update Download and apply go-ipfs updates
90
- version Show ipfs version information
91
- commands List all available commands
92
- id Show info about ipfs peers
93
-
94
- Advanced Commands:
95
-
88
+ refs <ref> List hashes of links from an object
89
+
90
+ DATA STRUCTURE COMMANDS
91
+
92
+ block Interact with raw blocks in the datastore
93
+ object Interact with raw dag nodes
94
+ file Interact with Unix filesystem objects
95
+
96
+ ADVANCED COMMANDS
97
+
98
daemon Start a long-running daemon process
99
mount Mount an ipfs read-only mountpoint
98
- serve Serve an interface to ipfs
100
+ resolve Resolve any type of name
101
+ name Publish or resolve IPNS names
102
+ dns Resolve DNS links
103
+ pin Pin objects to local storage
104
+ repo gc Garbage collect unpinned objects
105
+
106
+ NETWORK COMMANDS
107
+
108
+ id Show info about ipfs peers
109
+ bootstrap Add or remove bootstrap peers
110
+ swarm Manage connections to the p2p network
111
+ dht Query the dht for values or peers
112
+ ping Measure the latency of a connection
113
diag Print diagnostics
114
+
115
+ TOOL COMMANDS
116
+
117
+ config Manage configuration
118
+ version Show ipfs version information
119
+ update Download and apply go-ipfs updates
120
+ commands List all available commands
121
+
122
+ Use 'ipfs <command> --help' to learn more about each command.
123
101
- Plumbing commands:
102
-
103
- block Interact with raw blocks in the datastore
104
- object Interact with raw dag nodes
124
106
- Use 'ipfs <command> --help' to learn more about each command.
125
```
126
127
## Getting Started