Standardized Readme

This commit is contained in:
Richard Littauer 2016-09-27 10:17:38 -04:00
parent 7202d8da36
commit f0d3f5e3b4
1 changed files with 38 additions and 0 deletions

38
README.md Normal file
View File

@ -0,0 +1,38 @@
# go-floodsub
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-libp2p-blue.svg?style=flat-square)](http://github.com/libp2p/libp2p)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](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