readme-generator

Generate your project's README from package.json data! Uses Lo-Dash/Underscore-style templates. Need something more powerful and pluggable? Try verb instead!

Install

Install with npm

$ npm i -g readme-generator

CLI

From the command line, run:

$ readme
$ readme -t # readme template to use

Data

package.json and the parsed argv object are used as context for templates.

Example

Given the template Name: <%= foo %>, the following:

$ readme --foo bar

Would render Name: bar

README.md template

ERB/Lo-dash style templates may be used.

Examples

<%= name %>
<%= description %>
<%= license %>
<%= Object.keys(dependencies).join(', ') %>

Anything that works for Lo-Dash/Underscore templates should work here.

Custom template

If you add a .readme.md to the root of your project it will automatically be used. Or you can specify a custom template to use with the -t command.

If .readme.md and -t are not defined, the template.md in the root of this project will be used.

Escaping

Sometimes it's necessary to escape templates, like when you're documentation includes examples of templates. You can escape templates by adding an extra % in the opening delimiter.

Example

<%%= foo %>

Will render to:

<%= foo %>

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/
• twitter/

License

Copyright © 2018 Jon Schlinkert Licensed under the MIT license.

This file was generated by readme-generator on March 31, 2018.