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>
Steve Loeppky committed
Jul 20, 2022 at 06:53 UTC
639155c732c6af72855133c7f2776ffafe81d9ff
1 file changed
+2
-69
README.md
+2
-69
@@ -18,7 +18,7 @@ It includes:
18
- an [HTTP Gateway](https://github.com/ipfs/specs/tree/main/http-gateways#readme) (`/ipfs/`, `/ipns/`) for serving content to HTTP browsers
19
- an HTTP RPC API (`/api/v0`) for controlling the daemon node
20
21
-Note: [other implementations exist](https://ipfs.io/#install).
21
+Note: [other implementations exist](https://docs.ipfs.io/basics/ipfs-implementations/).
22
23
## What is IPFS?
24
@@ -320,10 +320,6 @@ Note: OpenSSL requires CGO support and, by default, CGO is disabled when cross-c
320
Ensure that `go version` reports at least 1.10. See above for how to install go.
321
- If you are interested in development, please install the development
322
dependencies as well.
323
-- _WARNING_: Older versions of OSX FUSE (for Mac OS X) can cause kernel panics when mounting!-
324
- We strongly recommend you use the [latest version of OSX FUSE](http://osxfuse.github.io/).
325
- (See https://github.com/ipfs/kubo/issues/177)
326
-- Read [docs/fuse.md](docs/fuse.md) for more details on setting up FUSE (so that you can mount the filesystem).
323
- Shell command completions can be generated with one of the `ipfs commands completion` subcommands. Read [docs/command-completion.md](docs/command-completion.md) to learn more.
324
- See the [misc folder](https://github.com/ipfs/kubo/tree/master/misc) for how to connect IPFS to systemd or whatever init system your distro uses.
325
@@ -395,70 +391,7 @@ If you believe you've found a bug, check the [issues list](https://github.com/ip
391
392
## Packages
393
398
-> This table is generated using the module [`package-table`](https://github.com/ipfs-shipyard/package-table) with `package-table --data=package-list.json`.
399
-
400
-Listing of the main packages used in the IPFS ecosystem. There are also three specifications worth linking here:
401
-
402
-| Name | CI/Travis | Coverage | Description |
403
-| ---------|---------|---------|--------- |
404
-| **Libp2p** |
405
-| [`go-libp2p`](//github.com/libp2p/go-libp2p) | [](https://travis-ci.com/libp2p/go-libp2p) | [](https://codecov.io/gh/libp2p/go-libp2p) | p2p networking library |
406
-| [`go-libp2p-pubsub`](//github.com/libp2p/go-libp2p-pubsub) | [](https://travis-ci.com/libp2p/go-libp2p-pubsub) | [](https://codecov.io/gh/libp2p/go-libp2p-pubsub) | pubsub built on libp2p |
407
-| [`go-libp2p-kad-dht`](//github.com/libp2p/go-libp2p-kad-dht) | [](https://travis-ci.com/libp2p/go-libp2p-kad-dht) | [](https://codecov.io/gh/libp2p/go-libp2p-kad-dht) | dht-backed router |
408
-| [`go-libp2p-pubsub-router`](//github.com/libp2p/go-libp2p-pubsub-router) | [](https://travis-ci.com/libp2p/go-libp2p-pubsub-router) | [](https://codecov.io/gh/libp2p/go-libp2p-pubsub-router) | pubsub-backed router |
409
-| **Multiformats** |
410
-| [`go-cid`](//github.com/ipfs/go-cid) | [](https://travis-ci.com/ipfs/go-cid) | [](https://codecov.io/gh/ipfs/go-cid) | CID implementation |
411
-| [`go-multiaddr`](//github.com/multiformats/go-multiaddr) | [](https://travis-ci.com/multiformats/go-multiaddr) | [](https://codecov.io/gh/multiformats/go-multiaddr) | multiaddr implementation |
412
-| [`go-multihash`](//github.com/multiformats/go-multihash) | [](https://travis-ci.com/multiformats/go-multihash) | [](https://codecov.io/gh/multiformats/go-multihash) | multihash implementation |
413
-| [`go-multibase`](//github.com/multiformats/go-multibase) | [](https://travis-ci.com/multiformats/go-multibase) | [](https://codecov.io/gh/multiformats/go-multibase) | mulitbase implementation |
414
-| **Files** |
415
-| [`go-unixfs`](//github.com/ipfs/go-unixfs) | [](https://travis-ci.com/ipfs/go-unixfs) | [](https://codecov.io/gh/ipfs/go-unixfs) | the core 'filesystem' logic |
416
-| [`go-mfs`](//github.com/ipfs/go-mfs) | [](https://travis-ci.com/ipfs/go-mfs) | [](https://codecov.io/gh/ipfs/go-mfs) | a mutable filesystem editor for unixfs |
417
-| [`go-ipfs-posinfo`](//github.com/ipfs/go-ipfs-posinfo) | [](https://travis-ci.com/ipfs/go-ipfs-posinfo) | [](https://codecov.io/gh/ipfs/go-ipfs-posinfo) | helper datatypes for the filestore |
418
-| [`go-ipfs-chunker`](//github.com/ipfs/go-ipfs-chunker) | [](https://travis-ci.com/ipfs/go-ipfs-chunker) | [](https://codecov.io/gh/ipfs/go-ipfs-chunker) | file chunkers |
419
-| **Exchange** |
420
-| [`go-ipfs-exchange-interface`](//github.com/ipfs/go-ipfs-exchange-interface) | [](https://travis-ci.com/ipfs/go-ipfs-exchange-interface) | [](https://codecov.io/gh/ipfs/go-ipfs-exchange-interface) | exchange service interface |
421
-| [`go-ipfs-exchange-offline`](//github.com/ipfs/go-ipfs-exchange-offline) | [](https://travis-ci.com/ipfs/go-ipfs-exchange-offline) | [](https://codecov.io/gh/ipfs/go-ipfs-exchange-offline) | (dummy) offline implementation of the exchange service |
422
-| [`go-bitswap`](//github.com/ipfs/go-bitswap) | [](https://travis-ci.com/ipfs/go-bitswap) | [](https://codecov.io/gh/ipfs/go-bitswap) | bitswap protocol implementation |
423
-| [`go-blockservice`](//github.com/ipfs/go-blockservice) | [](https://travis-ci.com/ipfs/go-blockservice) | [](https://codecov.io/gh/ipfs/go-blockservice) | service that plugs a blockstore and an exchange together |
424
-| **Datastores** |
425
-| [`go-datastore`](//github.com/ipfs/go-datastore) | [](https://travis-ci.com/ipfs/go-datastore) | [](https://codecov.io/gh/ipfs/go-datastore) | datastore interfaces, adapters, and basic implementations |
426
-| [`go-ipfs-ds-help`](//github.com/ipfs/go-ipfs-ds-help) | [](https://travis-ci.com/ipfs/go-ipfs-ds-help) | [](https://codecov.io/gh/ipfs/go-ipfs-ds-help) | datastore utility functions |
427
-| [`go-ds-flatfs`](//github.com/ipfs/go-ds-flatfs) | [](https://travis-ci.com/ipfs/go-ds-flatfs) | [](https://codecov.io/gh/ipfs/go-ds-flatfs) | a filesystem-based datastore |
428
-| [`go-ds-measure`](//github.com/ipfs/go-ds-measure) | [](https://travis-ci.com/ipfs/go-ds-measure) | [](https://codecov.io/gh/ipfs/go-ds-measure) | a metric-collecting database adapter |
429
-| [`go-ds-leveldb`](//github.com/ipfs/go-ds-leveldb) | [](https://travis-ci.com/ipfs/go-ds-leveldb) | [](https://codecov.io/gh/ipfs/go-ds-leveldb) | a leveldb based datastore |
430
-| [`go-ds-badger`](//github.com/ipfs/go-ds-badger) | [](https://travis-ci.com/ipfs/go-ds-badger) | [](https://codecov.io/gh/ipfs/go-ds-badger) | a badgerdb based datastore |
431
-| **Namesys** |
432
-| [`go-ipns`](//github.com/ipfs/go-ipns) | [](https://travis-ci.com/ipfs/go-ipns) | [](https://codecov.io/gh/ipfs/go-ipns) | IPNS datastructures and validation logic |
433
-| **Repo** |
434
-| [`go-fs-lock`](//github.com/ipfs/go-fs-lock) | [](https://travis-ci.com/ipfs/go-fs-lock) | [](https://codecov.io/gh/ipfs/go-fs-lock) | lockfile management functions |
435
-| [`fs-repo-migrations`](//github.com/ipfs/fs-repo-migrations) | [](https://travis-ci.com/ipfs/fs-repo-migrations) | [](https://codecov.io/gh/ipfs/fs-repo-migrations) | repo migrations |
436
-| **IPLD** |
437
-| [`go-block-format`](//github.com/ipfs/go-block-format) | [](https://travis-ci.com/ipfs/go-block-format) | [](https://codecov.io/gh/ipfs/go-block-format) | block interfaces and implementations |
438
-| [`go-ipfs-blockstore`](//github.com/ipfs/go-ipfs-blockstore) | [](https://travis-ci.com/ipfs/go-ipfs-blockstore) | [](https://codecov.io/gh/ipfs/go-ipfs-blockstore) | blockstore interfaces and implementations |
439
-| [`go-ipld-format`](//github.com/ipfs/go-ipld-format) | [](https://travis-ci.com/ipfs/go-ipld-format) | [](https://codecov.io/gh/ipfs/go-ipld-format) | IPLD interfaces |
440
-| [`go-ipld-cbor`](//github.com/ipfs/go-ipld-cbor) | [](https://travis-ci.com/ipfs/go-ipld-cbor) | [](https://codecov.io/gh/ipfs/go-ipld-cbor) | IPLD-CBOR implementation |
441
-| [`go-ipld-git`](//github.com/ipfs/go-ipld-git) | [](https://travis-ci.com/ipfs/go-ipld-git) | [](https://codecov.io/gh/ipfs/go-ipld-git) | IPLD-Git implementation |
442
-| [`go-merkledag`](//github.com/ipfs/go-merkledag) | [](https://travis-ci.com/ipfs/go-merkledag) | [](https://codecov.io/gh/ipfs/go-merkledag) | IPLD-Merkledag implementation (and then some) |
443
-| **Commands** |
444
-| [`go-ipfs-cmds`](//github.com/ipfs/go-ipfs-cmds) | [](https://travis-ci.com/ipfs/go-ipfs-cmds) | [](https://codecov.io/gh/ipfs/go-ipfs-cmds) | CLI & HTTP commands library |
445
-| [`go-ipfs-files`](//github.com/ipfs/go-ipfs-files) | [](https://travis-ci.com/ipfs/go-ipfs-files) | [](https://codecov.io/gh/ipfs/go-ipfs-files) | CLI & HTTP commands library |
446
-| [`go-ipfs-api`](//github.com/ipfs/go-ipfs-api) | [](https://travis-ci.com/ipfs/go-ipfs-api) | [](https://codecov.io/gh/ipfs/go-ipfs-api) | an old, stable shell for the IPFS HTTP API |
447
-| [`go-ipfs-http-client`](//github.com/ipfs/go-ipfs-http-client) | [](https://travis-ci.com/ipfs/go-ipfs-http-client) | [](https://codecov.io/gh/ipfs/go-ipfs-http-client) | a new, unstable shell for the IPFS HTTP API |
448
-| [`interface-go-ipfs-core`](//github.com/ipfs/interface-go-ipfs-core) | [](https://travis-ci.com/ipfs/interface-go-ipfs-core) | [](https://codecov.io/gh/ipfs/interface-go-ipfs-core) | core go-ipfs API interface definitions |
449
-| **Metrics & Logging** |
450
-| [`go-metrics-interface`](//github.com/ipfs/go-metrics-interface) | [](https://travis-ci.com/ipfs/go-metrics-interface) | [](https://codecov.io/gh/ipfs/go-metrics-interface) | metrics collection interfaces |
451
-| [`go-metrics-prometheus`](//github.com/ipfs/go-metrics-prometheus) | [](https://travis-ci.com/ipfs/go-metrics-prometheus) | [](https://codecov.io/gh/ipfs/go-metrics-prometheus) | prometheus-backed metrics collector |
452
-| [`go-log`](//github.com/ipfs/go-log) | [](https://travis-ci.com/ipfs/go-log) | [](https://codecov.io/gh/ipfs/go-log) | logging framework |
453
-| **Generics/Utils** |
454
-| [`go-ipfs-routing`](//github.com/ipfs/go-ipfs-routing) | [](https://travis-ci.com/ipfs/go-ipfs-routing) | [](https://codecov.io/gh/ipfs/go-ipfs-routing) | routing (content, peer, value) helpers |
455
-| [`go-ipfs-util`](//github.com/ipfs/go-ipfs-util) | [](https://travis-ci.com/ipfs/go-ipfs-util) | [](https://codecov.io/gh/ipfs/go-ipfs-util) | the kitchen sink |
456
-| [`go-ipfs-addr`](//github.com/ipfs/go-ipfs-addr) | [](https://travis-ci.com/ipfs/go-ipfs-addr) | [](https://codecov.io/gh/ipfs/go-ipfs-addr) | utility functions for parsing IPFS multiaddrs |
457
-
458
-For brevity, we've omitted most go-libp2p, go-ipld, and go-multiformats packages. These package tables can be found in their respective project's READMEs:
459
-
460
-* [go-libp2p](https://github.com/libp2p/go-libp2p#packages)
461
-* [go-ipld](https://github.com/ipld/go-ipld#packages)
394
+See [IPFS in GO](https://docs.ipfs.io/reference/go/api/) documentation.
395
396
## Development
397