arthurvr / generator-p

A minimal yeoman generator for npm packages.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

generator-p

Build Status

A minimal yeoman generator for npm packages. This is intended to cut out the majority of boilerplate required in creating a small npm module.

This generator prompts you for your:

  • Name
  • Github username
  • Twitter username
  • Package name
  • Package description

Using the information to create thorough package.json, index.js, LICENSE.md, test.js, and README.md files with the following structure:

awesome-package/
  - test/
    - test.js
  - .editorconfig
  - .gitignore
  - index.js
  - LICENSE.md
  - package.json
  - README.md

Installation

npm install -g generator-p

Usage

yo p

You will then be prompted for some information that will be used to generate an npm package.

License

MIT

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Crafted with <3 by John Otander (@4lpine).

About

A minimal yeoman generator for npm packages.

License:MIT License


Languages

Language:JavaScript 100.0%