generator-verb/app/templates/verb.md

Kickstart documentation for any project! This is the official Yeoman generator for Verb, the zero-configuration markdown docs generator that is extremely easy to use and extend.

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

> {%= description %}

## Install
{%= include("install-npm", {save: true}) %}

## Usage

```js
var <%= _.namify(appname) %> = require('{%= name %}');
```

## API
<!-- add a path or glob pattern for files with code comments to use for docs  -->
{%%= apidocs("index.js") %}

## Related projects
<!-- add an array of related projects, then un-escape the helper -->
{%%= related([]) %}  

## Running tests
{%= include("tests") %}

## Contributing
{%= include("contributing") %}

## Author
{%= include("author") %}

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

***

{%= include("footer") %}