From b0ecebfe438dcf1ddd4a68a493f36212a177e229 Mon Sep 17 00:00:00 2001 From: Gus Eggert Date: Fri, 10 Feb 2023 10:37:29 -0500 Subject: [PATCH] docs: add note in README that go-libipfs is not comprehensive --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2720610af..763ea1828 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ Some scenarios in which you may find go-libipfs helpful: Go-libipfs powers [Kubo](https://github.com/ipfs/kubo), which is the most popular IPFS implementation, so its code has been battle-tested on the IPFS network for years, and is well-understood by the community. +Go-libipfs is not exhaustive nor comprehensive--there are plenty of useful IPFS protocols, specs, libraries, etc. that are not in go-libipfs. The goal of go-libipfs is to provide cohesive and well-maintained components for common IPFS use cases. + ## What kind of components does go-libipfs have? Go-libipfs includes high-quality components useful for interacting with IPFS protocols, public and private IPFS networks, and content-addressed data, such as: @@ -55,7 +57,7 @@ We happily accept external contributions! However, go-libipfs maintains a high q * Complex components should have their own doc.go or README.md describing the component, its use cases, tradeoffs, design rationale, etc. * If the maintainers are not go-libipfs maintainers, then the component must include a CODEOWNERS file with at least two code owners who can commit to reviewing PRs -If you have some experimental component that you think would benefit the IPFS community, we suggest you build the component in your own repository until it's clear that there's community demand for it, and then open an issue in this repository to discuss including it in go-libipfs. +If you have some experimental component that you think would benefit the IPFS community, we suggest you build the component in your own repository until it's clear that there's community demand for it, and then open an issue/PR in this repository to discuss including it in go-libipfs. ## Help