From 6019771a0abf6a17ca128fcfb55156a5e2415cc4 Mon Sep 17 00:00:00 2001
From: Richard Littauer <richard.littauer@gmail.com>
Date: Fri, 24 Jun 2016 15:33:11 +0100
Subject: [PATCH] Standardize README

See ipfs/community#124
---
 README.md | 69 +++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 44 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index 2600b8b..8c9b08f 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-IPFS Block Service JavaScript Implementation
-=====================================
+# IPFS Block Service JavaScript Implementation
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
 [![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
 [![](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)
 [![Travis CI](https://travis-ci.org/ipfs/js-ipfs-block-service.svg?branch=master)](https://travis-ci.org/ipfs/js-ipfs-block-service)
 [![Circle CI](https://circleci.com/gh/ipfs/js-ipfs-block-service.svg?style=svg)](https://circleci.com/gh/ipfs/js-ipfs-block-service)
 [![Coverage Status](https://coveralls.io/repos/github/ipfs/js-ipfs-block-service/badge.svg?branch=master)](https://coveralls.io/github/ipfs/js-ipfs-block-service?branch=master)
@@ -13,8 +13,6 @@ IPFS Block Service JavaScript Implementation
 > [IPFS][ipfs] implementation of the BlockService and Block data structure in
 > JavaScript.
 
-## Description
-
 **BlockService** - A BlockService is a content-addressable store for blocks,
 providing an API for adding, deleting, and retrieving blocks. A BlockService is
 backed by an [IPFS Repo][repo] as its datastore for blocks, and uses [Bitswap][bitswap] to fetch blocks from the network.
@@ -31,7 +29,36 @@ backed by an [IPFS Repo][repo] as its datastore for blocks, and uses [Bitswap][b
 └─────────┘ └───────┘
 ```
 
-## Example
+## Table of Contents
+
+- [Install](#install)
+  - [npm](#npm)
+- [Usage](#usage)
+  - [Node.js](#nodejs)
+  - [Example](#example)
+  - [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
+  - [Browser: `<script>` Tag](#browser-script-tag)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Install
+
+### npm
+
+```sh
+> npm i ipfs-block-service
+```
+
+## Usage
+
+### Node.js
+
+```js
+const BlockService = require('ipfs-block-service')
+```
+
+
+### Example
 
 ```js
 const BlockService = require('ipfs-block-service')
@@ -69,22 +96,6 @@ true
 
 ```
 
-## Installation
-
-### npm
-
-```sh
-> npm i ipfs-block-service
-```
-
-## Setup
-
-### Node.js
-
-```js
-const BlockService = require('ipfs-block-service')
-```
-
 ### Browser: Browserify, Webpack, other bundlers
 
 The code published to npm that gets loaded on require is in fact a ES5
@@ -109,9 +120,17 @@ the global namespace.
 
 You can find the [API documentation here](API.md)
 
-## License
-
-MIT
-
 [ipfs]: https://ipfs.io
 [bitswap]: https://github.com/ipfs/specs/tree/master/bitswap
+
+## Contribute
+
+Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-block-service/issues)!
+
+This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
+
+## License
+
+[MIT](LICENSE)