# generator-nm [![Build Status](https://travis-ci.org/vladgolubev/generator-nm.svg?branch=master)](https://travis-ci.org/vladgolubev/generator-nm)

> Scaffold out a [node module](https://github.com/sindresorhus/node-module-boilerplate)

![](screenshot.png)


## Install

```
$ yarn global add yo @vladholubiev/generator-nm
```


## Usage

With [yo](https://github.com/yeoman/yo):

```
$ yo @vladholubiev/nm
```

There are multiple command-line options available:

```
$ yo @vladholubiev/nm --help

  Usage:
    yo @vladholubiev/nm [options]

  Options:
    --help          # Print the generator's options and usage
    --skip-cache    # Do not remember prompt answers                      Default: false
    --skip-install  # Do not automatically install dependencies           Default: false
    --org           # Publish to a GitHub organization account
    --cli           # Add a CLI
    --coverage      # Add code coverage with nyc
    --codecov       # Upload coverage to codecov.io (implies --coverage)
```

The `--org` option takes a string value (i.e. `--org=avajs`). All others are boolean flags and can be negated with the `no` prefix (i.e. `--no-codecov`). You will be prompted for any options not passed on the command-line.


## Tip

Use [chalk](https://github.com/sindresorhus/chalk) if you want colors in your CLI.


## License

MIT © [Sindre Sorhus](https://sindresorhus.com)