RichardLitt / standard-readme-cli

A CLI for standard readme
MIT License
2 stars 1 forks source link
cli hint hinter lint linter readme standard standard-readme

standard-readme-cli

A CLI tool for linting READMEs according to standard-readme

This is a Work in Progress. See #4.

Install

$ npm i -g standard-readme

Note: This package has overridden the old standard-readme, which is now used only for the spec and has been renamed on npm to standard-readme-spec.

Usage

In a folder with a 'README.md' file:

$ standard-readme
[]
/Users/richard/src/standard-readme-cli/README.md: no issues found

Maintainers

Contributing

Please do! Open an issue, or file a PR.

License

MIT © 2017 Richard Littauer