Home

Awesome

DRAFT STAGE

Please contribute in the issues to this evolving standard, as it makes no sense to define rules no one sticks to.

standard-readme

Describes how a README should look like, according to standard-readme

Travis Build Badge js-standard-style

Install

npm install standard-readme

Usage

$ readme README.md

var readme = require('standard-readme');

// Checks readme in current working directory
readme.check('.')

API

We need some more input for this. Consider sharing your opinion in this issue.

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. But before doing anything, please read the CONTRIBUTING.md guidelines.