From ba03b921d0d8d225f854acee57bc8db230e8f6fb Mon Sep 17 00:00:00 2001 From: Marten Seemann Date: Wed, 9 Feb 2022 17:26:44 +0530 Subject: [PATCH] update README --- README.md | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 131ca6c519..8caef9b527 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

- +

@@ -29,15 +29,13 @@ [libp2p](https://github.com/libp2p/specs) is a networking stack and library modularized out of [The IPFS Project](https://github.com/ipfs/ipfs), and bundled separately for other tools to use. > libp2p is the product of a long, and arduous quest of understanding -- a deep dive into the internet's network stack, and plentiful peer-to-peer protocols from the past. Building large-scale peer-to-peer systems has been complex and difficult in the last 15 years, and libp2p is a way to fix that. It is a "network stack" -- a protocol suite -- that cleanly separates concerns, and enables sophisticated applications to only use the protocols they absolutely need, without giving up interoperability and upgradeability. libp2p grew out of IPFS, but it is built so that lots of people can use it, for lots of different projects. -> -> We will be writing a set of docs, posts, tutorials, and talks to explain what p2p is, why it is tremendously useful, and how it can help your existing and new projects. But in the meantime, check out -> -> - [**Our developing collection of docs**](https://docs.libp2p.io) -> - [**Our community discussion forums**](https://discuss.libp2p.io) -> - [**The libp2p Specification**](https://github.com/libp2p/specs) -> - [**go-libp2p implementation**](https://github.com/libp2p/go-libp2p) -> - [**js-libp2p implementation**](https://github.com/libp2p/js-libp2p) -> - [**rust-libp2p implementation**](https://github.com/libp2p/rust-libp2p) + +To learn more, check out the following resources: +- [**Our documentation**](https://docs.libp2p.io) +- [**Our community discussion forum**](https://discuss.libp2p.io) +- [**The libp2p Specification**](https://github.com/libp2p/specs) +- [**js-libp2p implementation**](https://github.com/libp2p/js-libp2p) +- [**rust-libp2p implementation**](https://github.com/libp2p/rust-libp2p) ## Usage @@ -83,10 +81,6 @@ If you experience any issues migrating from gx to gomod, please [join the discus `go test ./...` will run all tests in the repo. -### Releasing - -Please start a release by opening a new [Libp2p Release](https://github.com/libp2p/go-libp2p/issues/new?assignees=&labels=kind/tracking&template=release.md) issue. - ### Packages > This table is generated using the module [`package-table`](https://github.com/ipfs-shipyard/package-table) with `package-table --data=package-list.json`. @@ -161,12 +155,9 @@ go-libp2p is part of [The IPFS Project](https://github.com/ipfs/ipfs), and is MI Guidelines: - read the [libp2p spec](https://github.com/libp2p/specs) -- please make branches + pull-request, even if working on the main repository -- ask questions or talk about things in [issues](https://github.com/libp2p/go-libp2p/issues), our [discussion forums](https://discuss.libp2p.io), or #libp2p or #ipfs on freenode. +- ask questions or talk about things in our [discussion forums](https://discuss.libp2p.io), or open an [issue](https://github.com/libp2p/go-libp2p/issues) for bug reports, or #libp2p on freenode. - ensure you are able to contribute (no legal issues please -- we use the DCO) -- run `go fmt` before pushing any code -- run `golint` and `go vet` too -- some things (like protobuf files) are expected to fail. -- get in touch with @raulk and @mgoelzer about how best to contribute +- get in touch with @marten-seemann about how best to contribute - have fun! There's a few things you can do right now to help out: