2016-05-13 19:30:44 +00:00
|
|
|
# readme-standard
|
2015-12-27 21:01:27 +00:00
|
|
|
|
|
|
|
|
[](http://ipn.io)
|
|
|
|
|
[](http://ipfs.io/)
|
2015-12-28 21:59:34 +00:00
|
|
|
[](http://webchat.freenode.net/?channels=%23ipfs)
|
2015-12-27 21:01:27 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2015-12-27 21:04:44 +00:00
|
|
|
> Standardize all IPFS Readme.md's and other markdown files
|
2015-12-27 23:13:58 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2015-12-28 16:01:03 +00:00
|
|
|
```sh
|
2016-05-13 19:30:44 +00:00
|
|
|
> npm i -g remark
|
|
|
|
|
> npm i
|
|
|
|
|
> remark README.md -o README.md
|
2015-12-27 23:13:58 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Contribute
|
|
|
|
|
|
|
|
|
|
Feel free to dive in! Open an issue or submit PRs.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2015-12-28 16:01:03 +00:00
|
|
|
MIT (c) Protocol Labs
|
