From 79423b41110f4e960f4b4e99e8bea9392a866c24 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Tue, 4 Oct 2016 09:49:26 -0400 Subject: [PATCH] Standardized Readme See #1 --- readme.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..c17dc8b --- /dev/null +++ b/readme.md @@ -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) +