Scaffold out a Standard Readme
MIT License
Scaffold out a Standard Readme
This generator conforms to the standard-readme specification. It creates a minimally compliant standard readme for your cross-language project, with some options.
Tip: Use chalk if you want colors in your CLI.
This generator requires node, npm, and yeoman.
You can install it by running:
npm install --global yo generator-standard-readme
With yo:
$ yo standard-readme
This will write a file, readme.md
, to the local directory.
standard-readme
will ask you a set of questions, which will help it fill out the README. These are:
Please contribute! Look at the issues.
MIT © 2016 Richard Littauer