# {{generator-docs}} [![NPM version](https://badge.fury.io/js/generator-docs.png)](http://badge.fury.io/js/generator-docs)  [![Build Status](https://travis-ci.org/jonschlinkert/generator-docs.png)](https://travis-ci.org/jonschlinkert/generator-docs)

> Yeoman generator for Writer. Generate project documentation templates or a README template for Writer to build.

## Getting Started
If you don't already have [Yeoman](http://yeoman.io/) installed, you must first run the following to be this generator:

```
$ npm install -g yo
```

Once Yeoman is installed, to install generator-docs from [npm](npmjs.org), run:

```
$ npm install -g generator-docs
```

Finally, initiate the generator:

```
$ yo generator-docs
```

### Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).

## Options

Command: `--skip-install`

Skips the automatic execution of `bower` and `npm` after scaffolding has finished.

## Author

**Jon Schlinkert**

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

## Related

* [Site generator](https://github.com/jonschlinkert/generator-site)
* [Assemble generator](https://github.com/assemble/generator-assemble)
* [Assemble Helper generator](https://github.com/assemble/generator-helper)
* [Assemble Plugin generator](https://github.com/assemble/generator-plugin)

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

***

_This file was generated by Writer on March 10, 2014._
