This repository has been archived by the owner on Dec 7, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from libp2p/feature/standardize-readme
Standardized Readme
- Loading branch information
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# go-libp2p-protocol | ||
|
||
[![](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) | ||
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) | ||
[![GoDoc](https://godoc.org/github.com/ipfs/go-libp2p-protocol?status.svg)](https://godoc.org/github.com/ipfs/go-libp2p-protocol) | ||
[![Coverage Status](https://coveralls.io/repos/github/ipfs/go-libp2p-protocol/badge.svg?branch=master)](https://coveralls.io/github/ipfs/go-libp2p-protocol?branch=master) | ||
[![Build Status](https://travis-ci.org/ipfs/go-libp2p-protocol.svg?branch=master)](https://travis-ci.org/ipfs/go-libp2p-protocol) | ||
|
||
> Just a type for protocol strings. Nothing more | ||
## Table of Contents | ||
|
||
- [Install](#install) | ||
- [Usage](#usage) | ||
- [Contribute](#contribute) | ||
- [Want to hack on IPFS?](#want-to-hack-on-ipfs) | ||
- [License](#license) | ||
|
||
## Install | ||
|
||
```sh | ||
go get libp2p/go-libp2p-protocol | ||
``` | ||
|
||
## Usage | ||
|
||
Go to https://godoc.org/github.com/libp2p/go-libp2p-protocol. | ||
|
||
## Contribute | ||
|
||
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/go-libp2p-protocol/issues)! | ||
|
||
Check out our [contributing document](https://github.com/libp2p/community/blob/master/CONTRIBUTE.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to libp2p 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. | ||
|
||
### Want to hack on IPFS? | ||
|
||
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md) | ||
|