/generator-goodeggs-npm

Generate npm modules the Good Eggs way

Primary LanguageCoffeeScript

generator-goodeggs-npm Build Status

Yeoman generator for NPM packages following Good Eggs conventions.

Getting Started

You need Yeoman:

$ npm install -g yo

generator-goodeggs-npm isn't published to NPM, since it's just for us. You can download it from our private NPM if you're connected to it:

$ npm install -g generator-goodeggs-npm

Or you can just point at the URL instead:

$ npm install -g git+https://github.com/goodeggs/generator-goodeggs-npm

Or even better, checkout and link the repo so you can quickly fix things that don't work right:

$ git clone https://github.com/goodeggs/generator-goodeggs-npm.git
$ cd generator-goodeggs-npm && npm link

Then you can start a new node module with:

$ mkdir my_special_module
$ cd $_
$ yo goodeggs-npm