A standard style for README files

Go to file

Richard Littauer 45d976c0a4 Small edits after running through remark		2015-12-28 11:01:03 -05:00
.gitignore	Initial commit	2015-10-16 16:35:17 -04:00
.remarkrc	Formatting	2015-12-27 18:14:09 -05:00
index.js	Added package, used lint	2015-12-27 16:04:44 -05:00
LICENSE	Initial commit	2015-10-16 16:35:17 -04:00
package.json	Added package, used lint	2015-12-27 16:04:44 -05:00
README.md	Small edits after running through remark	2015-12-28 11:01:03 -05:00

README.md

IPFS Readme Standard

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.

$ 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