Skip to content

Commit 3413ce3

Browse files
committed
Making clear that go-libipfs != IPFS
1 parent 1b12354 commit 3413ce3

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ go-libipfs 🍌
1717
- [About](#about)
1818
- [Motivation](#motivation)
1919
- [What kind of components does go-libipfs have?](#what-kind-of-components-does-go-libipfs-have)
20+
- [Does go-libipfs == IPFS?](#does-go-libipfs--ipfs)
2021
- [Is everything related to IPFS in the Go ecosystem in this repo?](#is-everything-related-to-ipfs-in-the-go-ecosystem-in-this-repo)
2122
- [Getting started](#getting-started)
2223
- [Should I add my IPFS component to go-libipfs?](#should-i-add-my-ipfs-component-to-go-libipfs)
@@ -30,7 +31,7 @@ go-libipfs 🍌
3031

3132
## About
3233

33-
Go-libips is a component library for building IPFS applications and implementations in Go.
34+
go-libips is a component library for building IPFS applications and implementations in Go.
3435

3536
Some scenarios in which you may find go-libipfs helpful:
3637

@@ -39,7 +40,7 @@ Some scenarios in which you may find go-libipfs helpful:
3940
* You want to reuse some components of IPFS such as its Kademlia DHT, Bitswap, data encoding, etc.
4041
* You want to experiment with IPFS
4142

42-
Go-libipfs powers [Kubo](https://github.com/ipfs/kubo), which is [the most popular IPFS implementation](https://github.com/protocol/network-measurements/tree/master/reports),
43+
go-libipfs powers [Kubo](https://github.com/ipfs/kubo), which is [the most popular IPFS implementation](https://github.com/protocol/network-measurements/tree/master/reports),
4344
so its code has been battle-tested on the IPFS network for years, and is well-understood by the community.
4445

4546
### Motivation
@@ -61,9 +62,12 @@ Go-libipfs includes high-quality components useful for interacting with IPFS pro
6162

6263
Go-libipfs aims to provide a cohesive interface into these components. Note that not all of the underlying components necessarily reside in this respository.
6364

65+
### Does go-libipfs == IPFS?
66+
No. This repo houses some IPFS functionality written in Go that has been useful in practice, and is maintained by a group that has long term commitments to the IPFS project
67+
6468
### Is everything related to IPFS in the Go ecosystem in this repo?
6569

66-
No. Not everything related to IPFS is intended to be in go-libipfs. Rather if you’d like to build an IPFS implementation with Go, here are some tools you might want that are maintained by a group that has long term commitments to the IPFS project. There are certainly repos that others maintainer that aren't included here (e.g., ipfs/go-car) which are still useful to IPFS implementations. It's expected and fine for new IPFS functionality to be developed that won't be part of go-libipfs.
70+
No. Not everything related to IPFS is intended to be in go-libipfs. View it as a starter toolbox (potentially among multiple). If you’d like to build an IPFS implementation with Go, here are some tools you might want that are maintained by a group that has long term commitments to the IPFS project. There are certainly repos that others maintainer that aren't included here (e.g., ipfs/go-car) which are still useful to IPFS implementations. It's expected and fine for new IPFS functionality to be developed that won't be part of go-libipfs.
6771

6872
## Getting started
6973
See [examples](./examples/README.md).

0 commit comments

Comments
 (0)