diff --git a/README.md b/README.md index 1fdce77..6db9233 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -IPFS Block JavaScript Implementation -==================================== +# IPFS Block 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.svg?branch=master)](https://travis-ci.org/ipfs/js-ipfs-block) [![Circle CI](https://circleci.com/gh/ipfs/js-ipfs-block.svg?style=svg)](https://circleci.com/gh/ipfs/js-ipfs-block) [![Coverage Status](https://coveralls.io/repos/github/ipfs/js-ipfs-block/badge.svg?branch=master)](https://coveralls.io/github/ipfs/js-ipfs-block?branch=master) @@ -12,22 +12,27 @@ IPFS Block JavaScript Implementation > [IPFS][ipfs] implementation of the Block data structure in JavaScript. -## Description - **Block** - A block is a blob of binary data. -## Example - -```js -const Block = require('ipfs-block') - -// create a block -const block = new Block('hello world') -console.log(block.data) -console.log(block.key) -``` - -## Installation +## 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: `