saturneric/standard-readme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Beefed up README

Browse Source
This commit is contained in:
Richard Littauer 2015-12-27 18:13:58 -05:00
parent e51095d9ba
commit 384f68ce1f
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -7,3 +7,24 @@
![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif) ![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)
> Standardize all IPFS Readme.md's and other markdown files > 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