Commit Graph

223 Commits

Author SHA1 Message Date
Jamie Dubs
052d797ca7
docs: Fix typo and grammar in README 2022-10-07 22:11:05 +02:00
@RubenKelevra
c7ed7ba722
Readme: Rewrite introduction and featureset (#9211)
* Readme: Rewrite introduction and featureset

* Readd links

Co-authored-by: Gus Eggert <gus@gus.dev>
2022-09-22 13:28:49 -04:00
Eli Bailey
aad1219529
docs: change windows choco install command to point to go-ipfs
Changes code example to use (what I believe is the) correct installation: https://community.chocolatey.org/packages/go-ipfs
2022-09-06 17:47:00 +02:00
Marcin Rataj
426cb84255 docs(readme): official vs unofficial packages 2022-08-31 15:00:27 +02:00
Marcin Rataj
bb59c052c2 docs(readme): update Docker section 2022-08-30 15:35:35 +02:00
Marcin Rataj
837f6ee92b chore: switch to dist.ipfs.tech
Part of https://github.com/protocol/bifrost-infra/issues/2018
ensures the domain used for fetching migrations is not
impacted by ipfs.io being blocked at DNS level by some ISPs.
2022-08-12 23:42:17 +02:00
Seungbae Yu
cb280cbf16
docs: replace docs.ipfs.io with docs.ipfs.tech (#9158)
* docs: fix redirecting URL in README.md
* all: replace `docs.ipfs.io` with `docs.ipfs.tech`
* apply suggestions from code review

Co-authored-by: Marcin Rataj <lidel@lidel.org>
2022-08-05 19:01:10 +03:00
link2xt
846d362581
docs: update Arch Linux installation instructions
Package is named `kubo`, not `go-ipfs` now.
2022-07-25 20:43:56 +02:00
Steve Loeppky
3902c9be00
docs(readme): add maintainer info (#9141)
* Update readme with important maintainer info.

The release process should have more visibility.  For now just getting the links at least surfaced.
2022-07-23 02:29:25 +02:00
Daniel Norman
5b1e04a7b8 fix: typo in README 2022-07-21 15:52:38 +00:00
Steve Loeppky
639155c732
docs(readme): move content to docs website (#9102)
- point towards other implementations.
- add a link to a future ipfs-implementations doc
- link to IPFS in GO docs

Co-authored-by: Marcin Rataj <lidel@lidel.org>
2022-07-20 15:53:41 +02:00
Marcin Rataj
9dbc9dfeb2 fix(cmds): use kubo in CheckVersionOption
Using both names to avoid dev problems during the transition from go-ipfs 0.13 to kubo 0.14
2022-07-06 23:08:31 +02:00
Marcin Rataj
3417ed466f docs: kubo description from dist.ipfs.io
:-)
2022-07-06 18:40:39 +02:00
Marcin Rataj
b9240fe432 refactor(docker): publish images under both names
This ensures we keep publishing the same image under both names:

    $ ./bin/get-docker-tags.sh $(date -u +%F) 88d88158c master                                                                                                                                 ...chore/rename-to-banana
    ipfs/kubo:master-2022-06-21-88d8815
    ipfs/go-ipfs:master-2022-06-21-88d8815
    ipfs/kubo:master-latest
    ipfs/go-ipfs:master-latest
2022-07-06 18:40:39 +02:00
Marcin Rataj
5cb572660d docs(readme): rename to kubo
some things like third party package names, docker image etc need to
stay as go-ipfs for now
2022-07-06 18:40:39 +02:00
Marcin Rataj
82467bc936 refactor: rename to kubo 2022-07-06 18:40:37 +02:00
Marcin Rataj
b6ded334ec
docs: add SECURITY.md (#9062)
* docs: add SECURITY.md

This moves existing security policy from README to SECURITY.md
which has a special meaning on Github:
https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository

* style: editoral fix

Co-authored-by: Steve Loeppky <biglep@protocol.ai>
2022-06-28 18:51:37 +02:00
Ikko Ashimine
b36044be34
chore: GitHub format 2022-06-09 17:36:51 +02:00
Laurent Senta
c9cf47dad5 config: remove go-ipfs-config code 2022-03-04 09:45:16 +01:00
Gus Eggert
2a871ef018
docs: add Snap note about customizing IPFS_PATH (#8584) 2022-01-06 08:58:33 -05:00
falstack
c00065cc84
chore: fix link in README.md (#8551)
update docs issues link
2021-11-23 23:41:26 +01:00
Yi Cao
3d9cb78ef1
Merge pull request #8545 from xiaoyu2006/patch-1
Add Homebrew installation method.
2021-11-10 10:32:43 -05:00
@RubenKelevra
04d1369a63 add more buttons; remove some sections covered in the docs; general cleanup
- added dynamic buttons for packages/downloads which shows the latest version where possible
- dynamic next milestone buttons
- reordered to have package managers and docker on top, manual downloads afterwards
- remove the docker and the cli section, since they are covered equally in the docs + button links
- added more sections to the navigation, to find stuff easier
- dynamic go requirement version button
- some social media buttons
- general cleanup
2021-09-02 12:22:54 +02:00
Steven Allen
9398d80878
Merge pull request #8220 from ShadSterling/patch-1
README.md: Add MacPorts to install section
2021-08-10 09:47:22 -07:00
Marcin Rataj
eda8b43a28 docs: chocolatey package name
We use go-ipfs name now, to make it clear that it is not ipfs-desktop.
2021-07-23 08:35:03 -07:00
Steven Allen
0060d5f7c8 feat: programmatic shell completions
These are missing some of the features of the current hand-rolled
completions, but:

1. Are less buggy.
2. Cover _all_ commands.
3. Don't need to be manually maintained (which we never do anyways).

fixes #4551
fixes #8033
2021-07-01 08:46:49 -07:00
Steven Allen
885325dd19 doc(README): update chat links (and misc fixes)
- Remove ipn.io link...
- Remove chat "badges" and replace with a single link.
- Remove reference to weekly meetings that no longer exist.

fixes #8190
2021-06-28 11:35:57 -07:00
Shad Sterling
1ea1493ed1
README.md: Add MacPorts to install section 2021-06-27 08:20:39 -04:00
Michael Burns
bdead901da
link to the actual doc (#8126)
* doc: link to the actual fuse doc
2021-06-25 08:35:59 -07:00
Adin Schmahmann
73e7e023c0 downgrade to 1.15.2 2021-05-12 17:59:20 -04:00
Adin Schmahmann
5a62025cc7 chore: bump minimum go version to 1.15 2021-05-12 17:16:47 -04:00
Marcin Rataj
8c1e4e99d1
docs: deprecate object commands
Part of https://github.com/ipfs/go-ipfs/issues/7936

This PR makes it very explicit that 'ipfs object' are deprecated
by removing examples and pointing at modern replacements under
'ipfs dag' and 'ipfs files'

Taglines are longer and include alternatives because we use them on:
https://docs.ipfs.io/reference/http/api/
2021-04-30 01:27:43 +02:00
Steven Allen
cc54ba1109
Merge pull request #8010 from ipfs/docs/cosmetic-fixes
docs: cosmetic fixes of help text
2021-03-30 15:52:38 -07:00
@RubenKelevra
db58dbc625 Readme: replace header image for dark mode
- Fix text contrast for dark mode and dimmed mode with white outlines around the black text

fixes ipfs#8024
2021-03-25 15:42:05 +01:00
Marcin Rataj
f91411362b
docs: ipfs object only works with dag-pb
Closes #7396
2021-03-24 20:49:50 +01:00
Marcin Rataj
5fad09909f
docs: suggest dag/files cmds in place of object
This is a cosmetic change to 'ipfs --help' that
reorders operations to prioritize 'dag' and 'files' over legacy 'object'.

Context: https://github.com/ipfs/go-ipfs/issues/7936
2021-03-24 18:13:31 +01:00
Marcin Rataj
0ff1cf33aa
docs: cosmetic fixes of help text
Unfortunately, API docs are genereted from go-ipfs sources
via https://github.com/ipfs/http-api-docs
so it all gets lost when API docs for new version are re-generated.

This re-applies manual fixes from:
https://docs.ipfs.io/reference/http/api/
so the next time http-api-docs are re-generated, those changes stay.
2021-03-24 17:41:14 +01:00
Marcin Rataj
2539c76177
docs(readme): key rotation in docker (#7721)
* docs(readme): key rotation in docker
Adds notes from https://github.com/ipfs/go-ipfs/issues/7714#issuecomment-706319721
2020-11-10 15:25:14 -05:00
@RubenKelevra
5c4f5adc85 README.md: remove link for init-systems to ipfs/website repo 2020-06-13 07:50:28 +02:00
@RubenKelevra
b0c359d538 readme: update go-version 2020-06-09 18:22:57 +02:00
@RubenKelevra
cb196d2495 README.md: documentation update, requires at least go 1.14.4 now 2020-06-05 03:16:49 +02:00
@RubenKelevra
2dc1f691f1 quic: remove experimental status and add it to the default config 2020-05-22 04:54:19 +02:00
Bernhard M. Wiedemann
0c88bcbfd5 Update go version required to build
based on mk/golang.mk
2020-05-08 06:11:12 +02:00
@RubenKelevra
24e5f95dc4 typo 2020-04-30 20:35:46 +02:00
Alan Shaw
3229c82ad8
docs: update licence info in README
Also tweaks "highly suggests" to "highly recommends". IMHO there are levels of recommendation but a suggestion is a boolean.
2020-03-02 10:11:42 +00:00
Will Scott
ca0ee36b8d
remove expired GPG key from README
Encourage initial bug reports to security@ to be unencrypted for faster triage
2020-02-25 12:30:29 -08:00
Steven Allen
0cd843ea68 chore: update the package list
It's not fully up-to-date but we're not going to keep this up-to-date without automation.
2020-02-21 13:50:20 -05:00
Steven Allen
627b62da36 fix(build): instruct users to use GOTAGS, not GOFLAGS
GOFLAGS will _override_ all the flags. If we just want to set a tag e.g., enable
OpenSSL, we should set GOTAGS=openssl.

fixes https://github.com/ipfs/go-ipfs/issues/6622#issuecomment-576713181
2020-01-21 08:16:29 -08:00
PoorPockets McNewHold
4c6ff8a134
Inclusion of the presence of the go-ipfs package in Solus
https://dev.getsol.us/T5361
2019-12-29 11:47:09 +00:00
Oli Evans
2885511059
chore: update readme badges to test ci
testing out circleci build triggers with a PR that tidies up the README badges

- remove somewhat redundant `project: ipfs` badge so they fit on 1 line. The link to the website is the url field for the repo.
- Use shields.io "flat square" style for godoc badge to match the others
- Use shields.io for the circleci badge too.
- re-order to be more visually pleasing.

License: MIT
Signed-off-by: Oli Evans <oli@tableflip.io>
2019-12-10 10:47:58 +00:00