generator-optick-node-module/README.md

A Yeoman generator that creates the perfect node module

# generator-optick-node-module [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Build status][buildkite-image]][buildkite-url]
[![reenkeeper badge][greenkeeper-image]][greenkeeper-url]
> A Yeoman generator that creates the perfect node module

## Installation

First, install [Yeoman](http://yeoman.io) and generator-optick-node-module using [npm](https://www.npmjs.com/) (we assume you have pre-installed
[node.js](https://nodejs.org/)).

```bash
npm install -g yo
npm install -g generator-optick-node-module
```

## Usage

Then generate your new project:

```bash
yo optick-node-module my-module
# Or leave out "my-module" if you're already in your project directory.
```

## License

ISC © [Ian Walter](https://iankwalter.com)

[npm-image]: https://badge.fury.io/js/generator-optick-node-module.svg
[npm-url]: https://npmjs.org/package/generator-optick-node-module
[daviddm-image]: https://david-dm.org/optick/generator-optick-node-module.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/optick/generator-optick-node-module
[buildkite-image]: https://badge.buildkite.com/7de8f79edf05bc00e0ec819f68ff82daa922b5945c2fac1d76.svg
[buildkite-url]: https://buildkite.com/optick/generator-optick-node-module
[greenkeeper-image]: https://badges.greenkeeper.io/optick/generator-optick-node-module.svg
[greenkeeper-url]: https://greenkeeper.io/