Commit Graph

83 Commits

Author SHA1 Message Date
Richard Littauer
eb955dff71 Standardized Readme
See https://github.com/ipfs/community/issues/124

License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
2016-06-21 18:31:25 +01:00
Juan Benet
868969fc39 Added readme image
it needs to be added to the repo or something later.
2016-06-07 12:59:59 -07:00
Richard Littauer
2511d8e571 Touch up language a bit
Seemed more natural.

License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
2016-05-19 15:29:49 +01:00
Jakub Sztandera
b64cc93b1b Remove note about Go1.6 not being supported
Recommend Go1.6.2
Note that Go1.5 is still supported

License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@protonmail.ch>
2016-05-18 22:09:11 +02:00
Christian Couder
12cdbe6cdd README: points to Windows doc
License: MIT
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
2016-05-16 06:37:45 +02:00
Christian Couder
255992873b README: remove reference to toolkit_upgrade
License: MIT
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
2016-05-16 06:23:30 +02:00
Stephen Whitmore
0a45ada4ed CLI: discoverability and consistency (#2542)
* reduces help indent from 4 to 2 spaces

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* reduces horz/vert space taken by "ipfs" cmd

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* show subcommands on shorthelp

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Drops colons at the end of cmd headings.

This makes command headings consistent with the output of 'ipfs', which
does not include colons.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* more consistent output between short-/long-help

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Puts DESCRIPTION before SUBCOMMANDS.

Users likely want to understand what a command does before worrying
about its subcommands.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Keeps ipfs cmd from outputting its subcmds twice.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant synopsis from "file"

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes extra whitespace from longhelp

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Consistent spacing whether SUBCMDS or not.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant SUBCMD output from ipfs object.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant synopsis from "name"

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Newline after Description only if it exists.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant synopsis from "bootstrap"

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant synopsis from "swarm"

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes trailing newline in ping help.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Prints shorthelp on parse error.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* tiny comment fixes

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* updates README usage

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Don't include extra whitespace if no .MoreHelp

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* description improvements

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Hides the obscure 'file' subcommand.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Splits 'ipfs daemon' into Short and Long help.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant synopsis from "config"

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Wraps lines to keep from going over 80.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* specify repo separately

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* s/structure/hierarchy

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* missing .

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes trailing colon from 'usage' test.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Updates sharness test error messages.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes trailing colon from 'usage' test.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Updates add-symlink to use /bin/sh.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes "hierarchy".

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Updates "ipfs ping" synopsis.

* Updates t0040 with latest wording.

* Removes unnecessary daemon setup.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>
2016-04-28 14:08:32 -07:00
Jeromy Johnson
3ee12782fc Merge pull request #2416 from noffle/readme_plusplus
Makes install from source instructions clearer.
2016-03-01 16:52:04 -08:00
Stephen Whitmore
e1612eba68 Makes install from source instructions clearer.
License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>
2016-02-29 08:55:06 -08:00
Jakub Sztandera
a7085d9830 Change link to dist to be under IPNS
Otherwise there is invalid cert error.

License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@protonmail.ch>
2016-02-29 16:04:44 +01:00
Jeromy
e7c8ac1f3e capitalize Ensure
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2016-02-23 11:01:56 -08:00
Jeromy
26af36eca1 refer to go install instructions
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2016-02-23 10:40:23 -08:00
Jeromy
f89b7c7679 some fixes to the readme install instructions
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2016-02-22 19:02:42 -08:00
Richard Littauer
ac42bb7932 Capitalized DHT
License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
2016-02-18 17:39:26 -05:00
Jakub Sztandera
ed3cf18f14 Update README gx section according to suggestions
License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@gmail.com>
2016-02-16 18:19:12 +01:00
Jakub Sztandera
91250c86b3 Add information about installing gx into readme
License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@gmail.com>
2016-02-15 10:11:53 +01:00
Jeromy Johnson
c913105dd7 Merge pull request #2308 from ipfs/docker-auto-builds
Docker automatic builds
2016-02-10 09:23:23 -08:00
Richard Littauer
7b1aa49c75 Added quotes around make install,
reworded

License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
2016-02-06 17:27:52 -05:00
Jeromy
455a785865 add some tips for making dep installs go smoothly
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2016-02-06 04:48:01 -08:00
Lars Gierth
e59dc8e49d docker: move to ipfs/go-ipfs image name
License: MIT
Signed-off-by: Lars Gierth <larsg@systemli.org>
2016-02-06 04:28:45 +01:00
Richard Littauer
9ade2109ed Cleaned up README
I did the following:
- Capitalized IPFS wherever it did not explicitely refer to the CLI command
- Moved Dev Dependencies into the Install section
- Added a Table of Contents
- Capitalised and added periods to various sentences
- Capitalised Go
- Removed double empty lines
- Reindented a few sections to make the flow more clear.
- Added a note to the Install section about how to canonically install.

License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
2016-02-05 11:08:12 -05:00
Jeromy
0dba051ce5 add better makefile and reference gx stuff in readme
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2016-01-30 09:34:10 -08:00
Richard Littauer
2df514c4f2 Change object to file
License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
2016-01-21 12:45:47 +01:00
ReadmeCritic
8457e08e68 Update README URLs based on HTTP redirects
License: MIT 
Signed-off-by: d. khamsing <dkhamsing8@gmail.com>
2016-01-05 09:06:51 -08:00
Jeromy
f9dc4c726b ipfs 0.3.10 release
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2015-12-07 20:50:01 -08:00
Jeromy
b99b77820d spelling
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2015-11-16 21:45:07 -08:00
Jeromy
2d2aa666eb fixes from PR
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2015-11-16 09:53:10 -08:00
Richard Littauer
cdcf457d8f Added a security section
See https://github.com/ipfs/community/issues/62

License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
2015-11-02 09:46:36 -05:00
Jeromy
ff3ed768e8 update go version requirement in readme
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2015-10-11 23:04:41 -07:00
Roerick Sweeney
4a0725fe2e added docker file permission instructions again
I screwed up my initial commit, so here goes again. That's what i get for using the github gui...

I added the instructions to make the ipfs_data and ipfs_staging globally readable, which prevents permission errors.

It may be better to limit permissions in some way, to prevent potential security risks.

License: MIT
Signed-off-by: sroerick sweeney@roerick.me
2015-09-27 02:06:53 -06:00
sroerick
279328c26b added docker file permission instructions. 2015-09-25 19:59:32 -06:00
Richard Littauer
3501aff032 Added a Contribute file
License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
2015-09-21 14:07:58 -04:00
Andres Buritica
f4989c30e7 Fix docker image link
License: MIT
Signed-off-by: Andres Buritica <andres@thelinuxkid.com>
2015-09-02 14:25:34 -07:00
drathir
a283db2328 Update README.md
Update the usage output to present one.
2015-08-25 15:38:03 +02:00
Francesco Canessa
8b6ec6600e Update link to ipfs installation guide
in Readme.md

License: MIT
Signed-off-by: Francesco (makevoid) <makevoid@gmail.com>
2015-08-03 00:08:34 +01:00
Juan Batiz-Benet
244c957488 updated install instructions
- links to ipfs.io
- links to gobuilder
- better instructions

License: MIT
Signed-off-by: Juan Batiz-Benet <juan@benet.ai>
2015-07-30 09:01:49 -07:00
Muneeb Ali
a70db393c6 Update README.md 2015-07-30 10:58:47 -04:00
Sean Lang
7ede3f44c5 Add link to init system examples - closes #1430
License: MIT
Signed-off-by: Sean Lang <slang800@gmail.com>
2015-07-05 22:46:16 -04:00
Chris Grimmett
10eecf06e0 add link to community contributing #1088 2015-05-07 14:33:55 +00:00
Stephan Seidt
7e1e96faf9 Change ipfs root path volume mount to /data/ipfs 2015-04-29 12:12:23 +02:00
Stephan Seidt
0f1f549585 Fix docker $ipfs_data mount path in README 2015-04-28 16:43:23 +02:00
Dylan Powers
71e8919101 Instructions for installing command completion in Linux bash 2015-04-22 11:35:31 -07:00
Christian Couder
96a22c5bb1 config: change default config dir name to .ipfs
This changes .go-ipfs to .ipfs everywhere.
And by the way this defines a DefaultPathName const
for this name.

License: MIT
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
2015-04-20 02:25:41 -07:00
Christian Couder
89961d9d9f README: alpha version has been released 2015-04-14 15:57:40 +02:00
Michael Lovci
aaa2a20730 Fixed broken link
Markdown didn't have "http://" so the link returned 404
2015-04-13 19:15:34 -03:00
Michael Lovci
e7115ba71d undo URL problems 2015-04-13 18:57:12 -03:00
Michael Lovci
2329ca117c Formatting bug 2015-04-13 18:56:19 -03:00
Michael Lovci
94c67bf7ff Formatting README.md for readibility 2015-04-13 17:42:27 -03:00
Michael Lovci
686bf81444 Changed docker hub source URL 2015-04-13 17:34:37 -03:00
Michael Lovci
97217c92a5 Added documentation for docker usage. #1052 2015-04-13 12:03:15 -03:00