standard-readme/README.md

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