Skip to content

Commit

Permalink
Standardized Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardLitt committed Sep 27, 2016
1 parent 7202d8d commit 19b02c2
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 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).

## License

[MIT](LICENSE) © Jeromy Johnson

0 comments on commit 19b02c2

Please sign in to comment.