docs: readme improvements
David Dias committed
Oct 1, 2019 at 12:10 UTC
81878a5d30b24963161fccf8ff8906d1df5caf3a
1 file changed
+27
-26
README.md
+27
-26
@@ -32,15 +32,17 @@ Please put all issues regarding:
32
- [Install Go](#install-go)
33
- [Download and Compile IPFS](#download-and-compile-ipfs)
34
- [Troubleshooting](#troubleshooting)
35
- - [Development Dependencies](#development-dependencies)
36
- - [Updating](#updating-go-ipfs)
37
-- [Usage](#usage)
35
+ - [Updating go-ipfs](#updating-go-ipfs)
36
- [Getting Started](#getting-started)
37
- [Some things to try](#some-things-to-try)
40
- - [Docker usage](#docker-usage)
38
+ - [Usage](#usage)
39
+ - [Running IPFS inside Docker](#running-ipfs-inside-docker)
40
- [Troubleshooting](#troubleshooting-1)
41
- [Packages](#packages)
42
- [Development](#development)
43
+ - [CLI, HTTP-API, Architecture Diagram](#cli-http-api-architecture-diagram)
44
+ - [Testing](#testing)
45
+ - [Development Dependencies](#development-dependencies)
46
- [Contributing](#contributing)
47
- [License](#license)
48
@@ -215,7 +217,26 @@ $ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-arm.tar.gz
217
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_windows-amd64.zip # windows 64-bit build
218
```
219
218
-## Usage
220
+## Getting Started
221
+
222
+See also: https://docs.ipfs.io/guides/guides/install
223
+
224
+To start using IPFS, you must first initialize IPFS's config files on your
225
+system, this is done with `ipfs init`. See `ipfs init --help` for information on
226
+the optional arguments it takes. After initialization is complete, you can use
227
+`ipfs mount`, `ipfs add` and any of the other commands to explore!
228
+
229
+### Some things to try
230
+
231
+Basic proof of 'ipfs working' locally:
232
+
233
+ echo "hello world" > hello
234
+ ipfs add hello
235
+ # This should output a hash string that looks something like:
236
+ # QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o
237
+ ipfs cat <that hash>
238
+
239
+### Usage
240
241
```
242
ipfs - Global p2p merkle-dag filesystem.
@@ -267,27 +288,7 @@ SUBCOMMANDS
288
export IPFS_PATH=/path/to/ipfsrepo
289
```
290
270
-## Getting Started
271
-
272
-See also: https://docs.ipfs.io/guides/guides/install
273
-
274
-To start using IPFS, you must first initialize IPFS's config files on your
275
-system, this is done with `ipfs init`. See `ipfs init --help` for information on
276
-the optional arguments it takes. After initialization is complete, you can use
277
-`ipfs mount`, `ipfs add` and any of the other commands to explore!
278
-
279
-### Some things to try
280
-
281
-Basic proof of 'ipfs working' locally:
282
-
283
- echo "hello world" > hello
284
- ipfs add hello
285
- # This should output a hash string that looks something like:
286
- # QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o
287
- ipfs cat <that hash>
288
-
289
-
290
-### Docker usage
291
+### Running IPFS inside Docker
292
293
An IPFS docker image is hosted at [hub.docker.com/r/ipfs/go-ipfs](https://hub.docker.com/r/ipfs/go-ipfs/).
294
To make files visible inside the container you need to mount a host directory