mirror of
https://github.com/logos-messaging/go-libp2p-pubsub.git
synced 2026-01-05 22:33:10 +00:00
docs: update readme welcome message
This commit is contained in:
parent
d3d43e32be
commit
14fab699aa
15
README.md
15
README.md
@ -16,15 +16,12 @@
|
|||||||
<br>
|
<br>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
> 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.
|
**PSA: The Hardening Extensions for Gossipsub (Gossipsub V1.1) can be found under development at https://github.com/libp2p/go-libp2p-pubsub/pull/263**
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
## Repo Lead Maintainer
|
## 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
|
### In this repo, you will find
|
||||||
|
|
||||||
See [libp2p/specs/pubsub#Implementations](https://github.com/libp2p/specs/tree/master/pubsub#Implementations).
|
|
||||||
|
|
||||||
```
|
```
|
||||||
.
|
.
|
||||||
├── LICENSE
|
├── LICENSE
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user