mirror of
https://github.com/logos-messaging/go-libp2p-pubsub.git
synced 2026-01-07 15:23:08 +00:00
Standardized Readme
This commit is contained in:
parent
7202d8da36
commit
f0d3f5e3b4
38
README.md
Normal file
38
README.md
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
# go-floodsub
|
||||||
|
|
||||||
|
[](http://ipn.io)
|
||||||
|
[](http://github.com/libp2p/libp2p)
|
||||||
|
[](http://webchat.freenode.net/?channels=%23ipfs)
|
||||||
|
|
||||||
|
> A flooding pubsub system.
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Install](#install)
|
||||||
|
- [Usage](#usage)
|
||||||
|
- [Contribute](#contribute)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```
|
||||||
|
go get libp2p/go-floodsub
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
TODO
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contribute
|
||||||
|
|
||||||
|
Contributions welcome. Please check out [the issues](https://github.com/libp2p/go-floodsub/issues).
|
||||||
|
|
||||||
|
Check out our [contributing document](https://github.com/libp2p/community/blob/master/contributing.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
|
||||||
|
|
||||||
|
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT](LICENSE) © Jeromy Johnson
|
||||||
Loading…
x
Reference in New Issue
Block a user