Merge pull request #38 from ipfs/feature/standardize-readme

Standarize Readme and add License

Author: RichardLitt

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Juan Batiz-Benet
+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

README.md

@@ -1,8 +1,34 @@
 # fs-repo-migrations
 
+[![](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)
+
+> Migrations for the filesystem repository of ipfs clients
+
 These are migrations for the filesystem repository of [ipfs](https://github.com/ipfs/ipfs) clients. This tool is written in Go, and developed alongside [go-ipfs](https://github.com/ipfs/go-ipfs), but it should work with any repo conforming to the [fs-repo specs](https://github.com/ipfs/specs/tree/master/repo/fs-repo).
 
-## When should I migrate
+## Table of Contents
+
+- [Install](#install)
+- [Usage](#usage)
+  - [When should I migrate](#when-should-i-migrate)
+  - [How to Run Migrations](#how-to-run-migrations)
+  - [Developing Migrations](#developing-migrations)
+- [Contribute](#contribute)
+  - [Want to hack on IPFS?](#want-to-hack-on-ipfs)
+- [License](#license)
+
+## Install
+
+```sh
+make install
+```
+
+## Usage
+
+### When should I migrate
 
 When you want to upgrade go-ipfs to a new version, you may need to
 migrate.
@@ -16,15 +42,29 @@ ipfs repo version | go-ipfs versions
                 2 |   0.3.0 - 0.3.11
                 3 |  0.4.0 - current
 
-## How to Run Migrations
+### How to Run Migrations
 
 Please see the [migration run guide here](run.md).
 
-## Developing Migrations
+### Developing Migrations
 
 Migrations are one of those things that can be extremely painful on users. At the end of the day, we want users never to have to think about it. The process should be:
 
 - SAFE. No data lost. Ever.
 - Revertible. Tools must implement forward and backward migrations.
 - Frozen. After the tool is written, all code must be frozen and vendored.
 - To Spec. The tools must conform to the spec.
+
+## Contribute
+
+Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/fs-repo-migrations/issues)!
+
+This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+### 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)
+
+## License
+
+MIT