Merge pull request #15 from multiformats/feature/standardize-readme

Standardized Readme

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Protocol Labs Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -2,16 +2,42 @@ js-multihash
 ============
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
+[![](https://img.shields.io/badge/project-multiformats-blue.svg?style=flat-square)](http://github.com/multiformats/multiformats)
 [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
 [![Coverage Status](https://coveralls.io/repos/github/multiformats/js-multihash/badge.svg?branch=master)](https://coveralls.io/github/multiformats/js-multihash?branch=master)
 [![Travis CI](https://travis-ci.org/multiformats/js-multihash.svg?branch=master)](https://travis-ci.org/multiformats/js-multihash)
 [![Circle CI](https://circleci.com/gh/multiformats/js-multihash.svg?style=svg)](https://circleci.com/gh/multiformats/js-multihash)
 [![Dependency Status](https://david-dm.org/multiformats/js-multihash.svg?style=flat-square)](https://david-dm.org/multiformats/js-multihash)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
 
-> [multihash](//github.com/multiformats/multihash) implementation.
-
-## Installation
+> multihash implementation in node.js
+
+This is the [multihash](//github.com/multiformats/multihash) implementation in Node.
+
+## Table of Contents
+
+- [Install](#install)
+  - [In Node.js through npm](#in-nodejs-through-npm)
+  - [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
+  - [In the Browser through `<script>` tag](#in-the-browser-through-script-tag)
+    - [Gotchas](#gotchas)
+- [Usage](#usage)
+- [API](#api)
+  - [`decode(buf)`](#decodebuf)
+  - [`encode(digest, hashfn[, length])`](#encodedigest-hashfn-length)
+  - [`toHexString(multihash)`](#tohexstringmultihash)
+  - [`fromHexString(string)`](#fromhexstringstring)
+  - [`toB58String(multihash)`](#tob58stringmultihash)
+  - [`fromB58String(string)`](#fromb58stringstring)
+  - [`coerceCode(name)`](#coercecodename)
+  - [`isAppCode(code)`](#isappcodecode)
+  - [`isValidCode(code)`](#isvalidcodecode)
+  - [`validate(multihash)`](#validatemultihash)
+- [Maintainers](#maintainers)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Install
 
 ### In Node.js through npm
 
@@ -152,6 +178,18 @@ Returns a boolean.
 
 Check if the given buffer is a valid multihash. Throws an error if it is not valid.
 
+## Maintainers
+
+Captain: [@diasdavid](https://github.com/diasdavid).
+
+## Contribute
+
+Contributions welcome. Please check out [the issues](https://github.com/multiformats/js-multihash/issues).
+
+Check out our [contributing document](https://github.com/multiformats/multiformats/blob/master/contributing.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats 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.
+
 ## License
 
-MIT
+[MIT] © Protocol Labs Inc.