From 14fab699aa01e82d81b5ec7edcb45688cb246f9b Mon Sep 17 00:00:00 2001 From: David Dias Date: Sun, 5 Apr 2020 13:22:28 +0100 Subject: [PATCH] docs: update readme welcome message --- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index cc180a5..7f902da 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,12 @@

-> A pubsub system with flooding and gossiping variants. +This repo contains the canonical pubsub implementation for libp2p. We currently provide three message router options: +- Floodsub, which is the baseline flooding protocol. +- Randomsub, which is a simple probabilistic router that propagates to random subsets of peers. +- Gossipsub, which is a more advanced router with mesh formation and gossip propagation. See [spec](https://github.com/libp2p/specs/tree/master/pubsub/gossipsub) and [implementation](https://github.com/libp2p/go-libp2p-pubsub/blob/master/gossipsub.go) for more details. -This is the canonical pubsub implementation for libp2p. - -We currently provide three implementations: -- floodsub, which is the baseline flooding protocol. -- gossipsub, which is a more advanced router with mesh formation and gossip propagation. - See [spec](https://github.com/libp2p/specs/tree/master/pubsub/gossipsub) and [implementation](https://github.com/libp2p/go-libp2p-pubsub/blob/master/gossipsub.go) for more details. -- randomsub, which is a simple probabilistic router that propagates to random subsets of peers. +**PSA: The Hardening Extensions for Gossipsub (Gossipsub V1.1) can be found under development at https://github.com/libp2p/go-libp2p-pubsub/pull/263** ## Repo Lead Maintainer @@ -67,8 +64,6 @@ See the [libp2p specs](https://github.com/libp2p/specs/tree/master/pubsub) for h ### In this repo, you will find -See [libp2p/specs/pubsub#Implementations](https://github.com/libp2p/specs/tree/master/pubsub#Implementations). - ``` . ├── LICENSE