.verb.md

Quickstart

CLI usage

Install globally with npm:

$ npm install --global {%= name %}

You should now be able to run this generator's default task with the gen git command. See all avallable tasks

API usage

Use as a plugin

Extend your own generator with the settings and features of {%= name %}:

module.exports = function(app) {
  app.use(require('{%= name %}'));
};

Use as a sub-generator

Add this generator to a namespace in your generator:

module.exports = function(app) {
  // you can use any arbitrary name to register the generator
  app.register('{%= alias %}', require('{%= name %}'));
};

See the API docs for more detailed examples and descriptions.

{{#block "about"}} When scaffolding out a new project, this generator simply automates a {%= alias %} first commit, making it a continuous part of the build workflow.

Run this generator with the gen {%= alias %} command, or use in your own generator as a plugin or sub-generator. {{/block}}

{{#block "tasks"}} The following tasks are registered on the {%= alias %} generator.

{%= headings(apidocs('generator.js')) %} {{/block}}

Docs