@asymmetrik/node-module-template

Template project for a node module

Table of Contents

• Use
• Install
• Usage
• API
• Contribute
• License

Use

To use this template, clone it, rename the origin remote to something else like template. Then, add the new repo as origin. Once you've done this, it will be easier to merge in changes to the template into your project.

A second option is to clone this repo, delete the ./.git directory, and then push it to your own repo.

See the gulpfile for tasks related to building the module.

Install

Include this module as a dependency of your application in the package.json file. For example:

{
  ...
  dependencies: {
    "@asymmetrik/node-module-template": "latest"
  }
  ...
}

Usage

Include the module via require wherever applicable:

var nodeModuleTemplate = require('@asymmetrik/node-module-template');

API

Contribute

PRs accepted.

License

See LICENSE for details