batovsky / npm-package

NPM package stub

package-name

Short info about your package.

What does your package.

Which limits has your package.

Installation

package-name can be installed using npm:

npm install package-name

Usage

To run package-name, you can use the following command from the project root:

./node_modules/.bin/package-name path[ path[...]]

Example:

var packageName = require('package-name');

packageName.doSomething();

Configuration

Detailed information about your package configuration.