standard-readme/README.md

# IPFS Readme Standard

[![](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/freejs-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)

![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)

> Standardize all IPFS Readme.md's and other markdown files

This repo is for standardizing how readmes should look for IPFS.

## Usage

The settings are stored in the `.remarkrc` file. Ideally, this file should be added to each repository where
you plan to use `remark`. There are plans to enable a single `.remarkrc` to be used in multiple repos.

```sh
$ npm i -g remark
$ npm i
$ remark README.md -o README.md
```

## Contribute

Feel free to dive in! Open an issue or submit PRs.

## License

MIT (c) Protocol Labs