From 384f68ce1fed9f3056a134f31e1fc21018c8454d Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Sun, 27 Dec 2015 18:13:58 -0500 Subject: [PATCH] Beefed up README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index a990c5b..a56964e 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,24 @@ ![](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. + +``` +$ 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 \ No newline at end of file