Verb examples. (1) is a readme template, (2) is the rendered readme.

1. README.tmpl.md

# {%= name %}

> {%= description %}

Sed ut perspiciatis unde omnis iste natus error sit voluptatem
accusantium doloremque laudantium, totam rem aperiam.

## Contribute
{%= docs("contributing") %}

## License
Copyright (c) {%= date('YYYY') %} {%= author.name %}, contributors.
Released under the {%= license.type %} license

***

{%= include("footer") %}

2. README.md

verb

Verb makes it easy to build project documentation using simple markdown templates, with zero configuration required.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam.

Contribute

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality, and please re-build the documentation with verb-cli before submitting a pull request.

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license

---

This file was generated by verb-cli on March 22, 2014.

README-alt.tmpl.md

{%= name %} {%= badge("fury") %}

{%= description %}

Install

{%= include("install") %}

Contribute

{%= docs("contributing") %}

Author

{%= contrib("authors") %}

License

{%= copyright() %} {%= license() %}

---

{%= include("footer") %}

Most of the fields are automatically populated with data from your project's package.json. Here are the exceptions:

• Verb uses moment.js for {%= date() %}
• {%= docs() %} will include a file from the docs directory of your project (must have a .md extension)
• {%= include() %} like docs, but includes a "generic" file from verb-readme-includes

Last, make sure you use the correct variables for your project!!

For example, if author if formatted as a string, like this:

{
  "author": "Jon Schlinkert"
}

then use {%= author %}, not {%= author.name %}.