create-yo/README.md

Use Yeoman generators via "npm init"

# create-yo

> Use any Yeoman generator with "npm init"

As of npm v6.1.0, you can [use a custom package](https://github.com/npm/npm/pull/20403) with `npm init` to scaffold a project.

## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [License](#license)

## Install

You _could_ install this, but you shouldn't have to. Use `npm` to install globally if you wish.

### Requirements

- Node.js v10.0.0+
- npm v6.1.0+

## Usage

```shell
$ npm init yo <some-generator>[:subgenerator]
```

All Yeoman generator packages start with `generator-`; this prefix is _optional_ **unless you are using a scoped package**. In other words, `npm init yo license` will work just as well as `npm init yo generator-license`, but to use generator `@butts/generator-butts`, you must specify the complete package name with `npm init yo @butts/generator-butts`.

See [a list of generators here](http://yeoman.io/generators/).

## Notes

This package does little other than monkey with arguments and invoke `npx` programmatically.

## Contribution

Please use [Conventional Commit conventions](https://www.conventionalcommits.org). Commit messages are checked via Git hook using [commitlint](https://npm.im/@commitlint/cli).

## Maintainers

[@boneskull](https://github.com/boneskull)

## License

Copyright © 2019 Christopher Hiller. Licensed Apache-2.0