Skip to content
This repository was archived by the owner on Aug 11, 2021. It is now read-only.

Commit 6019771

Browse files
committed
Standardize README
See ipfs/community#124
1 parent 7eba946 commit 6019771

File tree

1 file changed

+44
-25
lines changed

1 file changed

+44
-25
lines changed

README.md

+44-25
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
IPFS Block Service JavaScript Implementation
2-
=====================================
1+
# IPFS Block Service JavaScript Implementation
32

43
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
54
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
65
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
6+
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
77
[![Travis CI](https://travis-ci.org/ipfs/js-ipfs-block-service.svg?branch=master)](https://travis-ci.org/ipfs/js-ipfs-block-service)
88
[![Circle CI](https://circleci.com/gh/ipfs/js-ipfs-block-service.svg?style=svg)](https://circleci.com/gh/ipfs/js-ipfs-block-service)
99
[![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
1313
> [IPFS][ipfs] implementation of the BlockService and Block data structure in
1414
> JavaScript.
1515
16-
## Description
17-
1816
**BlockService** - A BlockService is a content-addressable store for blocks,
1917
providing an API for adding, deleting, and retrieving blocks. A BlockService is
2018
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
3129
└─────────┘ └───────┘
3230
```
3331

34-
## Example
32+
## Table of Contents
33+
34+
- [Install](#install)
35+
- [npm](#npm)
36+
- [Usage](#usage)
37+
- [Node.js](#nodejs)
38+
- [Example](#example)
39+
- [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
40+
- [Browser: `<script>` Tag](#browser-script-tag)
41+
- [Contribute](#contribute)
42+
- [License](#license)
43+
44+
## Install
45+
46+
### npm
47+
48+
```sh
49+
> npm i ipfs-block-service
50+
```
51+
52+
## Usage
53+
54+
### Node.js
55+
56+
```js
57+
const BlockService = require('ipfs-block-service')
58+
```
59+
60+
61+
### Example
3562

3663
```js
3764
const BlockService = require('ipfs-block-service')
@@ -69,22 +96,6 @@ true
6996
7097
```
7198

72-
## Installation
73-
74-
### npm
75-
76-
```sh
77-
> npm i ipfs-block-service
78-
```
79-
80-
## Setup
81-
82-
### Node.js
83-
84-
```js
85-
const BlockService = require('ipfs-block-service')
86-
```
87-
8899
### Browser: Browserify, Webpack, other bundlers
89100

90101
The code published to npm that gets loaded on require is in fact a ES5
@@ -109,9 +120,17 @@ the global namespace.
109120

110121
You can find the [API documentation here](API.md)
111122

112-
## License
113-
114-
MIT
115-
116123
[ipfs]: https://ipfs.io
117124
[bitswap]: https://github.com/ipfs/specs/tree/master/bitswap
125+
126+
## Contribute
127+
128+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-block-service/issues)!
129+
130+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
131+
132+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
133+
134+
## License
135+
136+
[MIT](LICENSE)

0 commit comments

Comments
 (0)