Commit Graph

110 Commits

Author SHA1 Message Date
Whyrusleeping
bbdbd0ac6f
Merge pull request #4398 from ipfs/fix/hamt-bug
fix hamt delete issue
2017-12-05 20:53:51 +01:00
Jeromy
1a75c40f5b require go1.9
License: MIT
Signed-off-by: Jeromy <jeromyj@gmail.com>
2017-12-04 09:33:20 -08:00
John Reed
bbeee1af50
adding how to download IPFS with IPFS
Adding instructions for downloading IPFS builds with IPFS

License: MIT
Signed-off-by: John Reed <john@re2d.xyz>
2017-11-14 13:48:43 -06:00
Steven Allen
2b40a713bf doc: remove mention of the IPFS alpha
License: MIT
Signed-off-by: Steven Allen <steven@stebalien.com>
2017-10-26 11:10:55 -07:00
Steven Allen
ddcfef42f8 doc: mention the discourse forum
License: MIT
Signed-off-by: Steven Allen <steven@stebalien.com>
2017-10-26 11:10:18 -07:00
kpcyrd
65175e8ac9 README.md: Suggest safer docker flags
Resolves #4271

License: MIT
Signed-off-by: kpcyrd <git@rxv.cc>
2017-10-02 15:35:48 +02:00
Jon Choi
f7883ed1b3 README.md: Notes on where to start reading code
Based on response from @whyrusleeping. (https://github.com/ipfs/go-ipfs/issues/4048#issuecomment-313774707)

License: MIT
Signed-off-by: Jon Choi <choi.jonathanh@gmail.com>
2017-07-07 15:41:10 -07:00
Łukasz Magiera
c2603538fe docs: Require go 1.8
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
2017-07-07 20:02:42 +02:00
Sag0Sag0
90287f3b3c Added info on compiling on FreeBSD. (#3959)
License: MIT
Signed-off-by: Laurence Stevens <laurencebelastevens@gmail.com>
2017-06-06 19:52:40 -07:00
Willi Butz
2f761081ec
README.md: add Nix to the linux package managers
License: MIT
Signed-off-by: Willi Butz <wbutz@cyberfnord.de>
2017-05-25 12:50:58 +02:00
kpcyrd
4f98f8fa3b Link docs/openbsd.md in readme
License: MIT
Signed-off-by: kpcyrd <git@rxv.cc>
2017-04-27 01:06:32 +02:00
kpcyrd
3c96b09ae7 docker: Automatically fix permissions
This patch is delaying the point where permissions are dropped into the `start_ipfs` script. This way, instead of exiting on permission issues, we can fix them on our own inside the script, then drop privileges and continue doing ipfs specific stuff with the correct user.

I've removed the `chmod 0777` step from the readme since it's not needed anymore.

License: MIT
Signed-off-by: kpcyrd <git@rxv.cc>
2017-03-03 21:10:02 +01:00
Jakub Sztandera
773f771b5d
readme: add toc of pkg managers
License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@protonmail.ch>
2017-03-02 19:04:04 +01:00
Jakub Sztandera
ad6396e5af
readme: add Arch install instruction
License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@protonmail.ch>
2017-03-02 18:59:41 +01:00
Jakub Sztandera
68db94c3eb
misc: simplify readme installation instructions
License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@protonmail.ch>
2017-02-22 22:28:17 +01:00
Jeromy Johnson
24a32bf9e8 Merge pull request #3602 from rht/throughput
Add closed PRs, Issues throughput
2017-02-14 14:33:47 -08:00
Leo Arias
50ee67f05f add the snap installation instructions
License: MIT
Signed-off-by: Leo Arias <yo@elopio.net>
2017-02-07 21:26:05 +00:00
rht
80703f29c7
Add closed PRs, Issues throughput
License: MIT
Signed-off-by: rht <rhtbot@gmail.com>
2017-01-16 23:45:19 +04:00
Lars Gierth
1eef1ef389 assets: add security@ipfs.io GPG key
License: MIT
Signed-off-by: Lars Gierth <larsg@systemli.org>
2016-11-03 00:37:34 +01:00
Lars Gierth
dd1caddccb readme: fix go get invocations
They didn't previously make sure the code was up-to-date.

License: MIT
Signed-off-by: Lars Gierth <larsg@systemli.org>
2016-10-06 17:42:10 +02:00
Jakub Sztandera
56004ca6c2
readme: add -u to gx install commands in manual build instructions
License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@protonmail.ch>
2016-09-19 16:59:51 +02:00
Jeromy
4974136a1a bump go requirement to 1.7
License: MIT
Signed-off-by: Jeromy <why@ipfs.io>
2016-08-23 10:46:17 -07:00
Jeromy Johnson
740a0943cc Merge pull request #3051 from ipfs/doc/manual-building
readme: add notes on building for uncommon systems
2016-08-16 12:49:35 -07:00
Richard Littauer
4f4f57e030 Small edits
License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
2016-08-16 13:50:32 -04:00
Jeromy
1581265c2c readme: add notes on building for uncommon systems
License: MIT
Signed-off-by: Jeromy <why@ipfs.io>
2016-08-07 10:31:59 -07:00
zramsay
3069adf535 boot2docker-cli is deprecated, removed from README
- Docker for Mac/Windows is out of beta
- docker-machine is recommended for unsupported machines

License: MIT
Signed-off-by: Zach Ramsay <zach@erisindustries.com>
2016-08-06 23:28:16 +01:00
Lars Gierth
ec68ef01f1 cleanup: remove mentions of gobuilder
License: MIT
Signed-off-by: Lars Gierth <larsg@systemli.org>
2016-07-23 13:09:32 +01:00
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