verb/README.md

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

# verb [![NPM version](https://badge.fury.io/js/verb.png)](http://badge.fury.io/js/verb)

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

* Get [verb-cli](https://github.com/assemble/verb-cli) to use Verb globally from the command line
* Get [generator-verb](https://github.com/assemble/generator-verb) to add documentation templates, or initialize docs for new projects

## Meet Verb
Verb's CLI makes kickstarting new documentation a breeze. Here is how Verb can keep your documentation up-to-date using variables from your [project's package.json](#TODO: add link to 'data'):

```markdown
# {%= name %}

> {%= description %}

Sed ut perspiciatis unde omnis iste natus error sit voluptatem
accusantium doloremque laudantium, totam rem aperiam.
```
Now put this in `docs/README.tmpl.md` and run `verb` to build it! It's that easy!

Need more than simple variables? Use one of Verb's [built-in tags](#TODO: add link), like `date()`:

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

Include other documents, allowing them to be reused across multiple projects, or just to organize:

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

That's it! _(More docs are on the way.)_

## Customize Verb

Verb is easy to extend, here are some examples ([verb-cli](https://github.com/assemble/verb-cli) will automatically use these):

* [example verbfile](https://gist.github.com/jonschlinkert/9685280), with custom `src`, `dest` and metadata.
* [example verbfile with logging](https://gist.github.com/jonschlinkert/9685144)
* [example .verbrc.yml](https://gist.github.com/jonschlinkert/9686195)

## Install
Install with [npm](npmjs.org):

```bash
npm i verb --save-dev
```

Be sure to install [Verb](https://github.com/assemble/verb) locally in projects that use Verb.

## Other tools

* Get [grunt-verb](https://github.com/assemble/grunt-verb) to automate Verb in your Grunt tool-chains
* Get [gulp-verb](https://github.com/assemble/gulp-verb) to automate Verb in your gulp tool-chains

## Author

**Jon Schlinkert**

+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

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

***

_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on March 21, 2014._