Skip to content

Commit

Permalink
Standardized Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardLitt committed Oct 11, 2016
1 parent f4e5710 commit b8d5a53
Showing 1 changed file with 39 additions and 3 deletions.
42 changes: 39 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,38 @@
# go-multistream

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-multiformats-blue.svg?style=flat-square)](http://github.com/multiformats/multiformats)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![Coverage Status](https://coveralls.io/repos/github/multiformats/go-multistream/badge.svg?branch=master)](https://coveralls.io/github/multiformats/go-multistream?branch=master)

#Multistream-select router
> an implementation of the multistream protocol in go
This package implements a simple stream router for the multistream-select protocol.
The protocol is defined [here](https://github.com/multiformats/multistream-select).

## Table of Contents


- [Install](#install)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contribute](#contribute)
- [License](#license)

Usage:
## Install

```sh
go get multiformats/go-multistream
```

## Usage

```go
package main

import (
"fmt"
ms "github.com/whyrusleeping/go-multistream"
ms "github.com/multiformats/go-multistream"
"io"
"net"
)
Expand Down Expand Up @@ -43,3 +63,19 @@ func main() {
}
}
```

## Maintainers

Captain: [@whyrusleeping](https://github.com/whyrusleeping).

## Contribute

Contributions welcome. Please check out [the issues](https://github.com/multiformats/go-multistream/issues).

Check out our [contributing document](https://github.com/multiformats/multiformats/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)

0 comments on commit b8d5a53

Please sign in to comment.