From c1f75eee815303596cf478b4adb086f9dfaae519 Mon Sep 17 00:00:00 2001 From: Max Inden Date: Tue, 16 Mar 2021 15:14:17 +0100 Subject: [PATCH] README: Express preference for Github discussions for questions (#1996) * README: Express preference for Github issues for questions * README: Remove IRC and mention Discussions forum Co-authored-by: Roman Borschel --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fba4cb15..9bc3cf9a 100644 --- a/README.md +++ b/README.md @@ -9,18 +9,21 @@ This repository is the central place for Rust development of the [libp2p](https: **Warning**: While we are trying our best to be compatible with other libp2p implementations, we cannot guarantee that this is the case considering the lack of a precise libp2p specifications. -## Documentation +## Getting started -How to use the library? +- **Main documentation** can be found on https://docs.rs/libp2p. -- Main documentation: https://docs.rs/libp2p +- The **[examples](examples)** folder contains small binaries showcasing the + many protocols in this repository. -Where to ask questions? +- To **report bugs, suggest improvements or request new features** please open + GitHub issue on this repository. -- In the Rust section of https://discuss.libp2p.io. -- In the #libp2p IRC channel on freenode. -- By opening an issue in this repository. +- For **rust-libp2p specific questions** please use the GitHub _Discussions_ + forum https://github.com/libp2p/rust-libp2p/discussions. +- For **discussions and questions related to multiple libp2p implementations** + please use the libp2p _Discourse_ forum https://discuss.libp2p.io. ## Repository Structure