Home

Awesome

generator-standard-readme

Build Status

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.

Table of Contents

Install

This generator requires node, npm, and yeoman.

You can install it by running:

npm install --global yo generator-standard-readme

Usage

With yo:

$ yo standard-readme

This will write a file, readme.md, to the local directory.

Fields to fill out

standard-readme will ask you a set of questions, which will help it fill out the README. These are:

Maintainer

@RichardLitt

Contributing

Please contribute! Look at the issues.

License

MIT © 2016 Richard Littauer