Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
10
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
dms3
go-dms3
Commits
81878a5d
Commit
81878a5d
authored
Oct 01, 2019
by
David Dias
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: readme improvements
parent
949cac23
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
27 additions
and
26 deletions
+27
-26
README.md
README.md
+27
-26
No files found.
README.md
View file @
81878a5d
...
@@ -32,15 +32,17 @@ Please put all issues regarding:
...
@@ -32,15 +32,17 @@ Please put all issues regarding:
-
[
Install Go
](
#install-go
)
-
[
Install Go
](
#install-go
)
-
[
Download and Compile IPFS
](
#download-and-compile-ipfs
)
-
[
Download and Compile IPFS
](
#download-and-compile-ipfs
)
-
[
Troubleshooting
](
#troubleshooting
)
-
[
Troubleshooting
](
#troubleshooting
)
-
[
Development Dependencies
](
#development-dependencies
)
-
[
Updating go-ipfs
](
#updating-go-ipfs
)
-
[
Updating
](
#updating-go-ipfs
)
-
[
Usage
](
#usage
)
-
[
Getting Started
](
#getting-started
)
-
[
Getting Started
](
#getting-started
)
-
[
Some things to try
](
#some-things-to-try
)
-
[
Some things to try
](
#some-things-to-try
)
-
[
Docker usage
](
#docker-usage
)
-
[
Usage
](
#usage
)
-
[
Running IPFS inside Docker
](
#running-ipfs-inside-docker
)
-
[
Troubleshooting
](
#troubleshooting-1
)
-
[
Troubleshooting
](
#troubleshooting-1
)
-
[
Packages
](
#packages
)
-
[
Packages
](
#packages
)
-
[
Development
](
#development
)
-
[
Development
](
#development
)
-
[
CLI, HTTP-API, Architecture Diagram
](
#cli-http-api-architecture-diagram
)
-
[
Testing
](
#testing
)
-
[
Development Dependencies
](
#development-dependencies
)
-
[
Contributing
](
#contributing
)
-
[
Contributing
](
#contributing
)
-
[
License
](
#license
)
-
[
License
](
#license
)
...
@@ -215,7 +217,26 @@ $ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-arm.tar.gz
...
@@ -215,7 +217,26 @@ $ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_linux-arm.tar.gz
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_windows-amd64.zip # windows 64-bit build
$ ipfs get /ipns/dist.ipfs.io/go-ipfs/$VERSION/go-ipfs_$VERSION_windows-amd64.zip # windows 64-bit build
```
```
## Usage
## Getting Started
See also: https://docs.ipfs.io/guides/guides/install
To start using IPFS, you must first initialize IPFS's config files on your
system, this is done with
`ipfs init`
. See
`ipfs init --help`
for information on
the optional arguments it takes. After initialization is complete, you can use
`ipfs mount`
,
`ipfs add`
and any of the other commands to explore!
### Some things to try
Basic proof of 'ipfs working' locally:
echo "hello world" > hello
ipfs add hello
# This should output a hash string that looks something like:
# QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o
ipfs cat <that hash>
### Usage
```
```
ipfs - Global p2p merkle-dag filesystem.
ipfs - Global p2p merkle-dag filesystem.
...
@@ -267,27 +288,7 @@ SUBCOMMANDS
...
@@ -267,27 +288,7 @@ SUBCOMMANDS
export IPFS_PATH=/path/to/ipfsrepo
export IPFS_PATH=/path/to/ipfsrepo
```
```
## Getting Started
### Running IPFS inside Docker
See also: https://docs.ipfs.io/guides/guides/install
To start using IPFS, you must first initialize IPFS's config files on your
system, this is done with
`ipfs init`
. See
`ipfs init --help`
for information on
the optional arguments it takes. After initialization is complete, you can use
`ipfs mount`
,
`ipfs add`
and any of the other commands to explore!
### Some things to try
Basic proof of 'ipfs working' locally:
echo "hello world" > hello
ipfs add hello
# This should output a hash string that looks something like:
# QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o
ipfs cat <that hash>
### Docker usage
An IPFS docker image is hosted at
[
hub.docker.com/r/ipfs/go-ipfs
](
https://hub.docker.com/r/ipfs/go-ipfs/
)
.
An IPFS docker image is hosted at
[
hub.docker.com/r/ipfs/go-ipfs
](
https://hub.docker.com/r/ipfs/go-ipfs/
)
.
To make files visible inside the container you need to mount a host directory
To make files visible inside the container you need to mount a host directory
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment