Contributing

This project is currently firmly in the planning and prototyping stages at the moment. Any contributions in the form of pull requests or issues for discussion are welcome.

Prerequisites

Node.js >= v4 must be installed.

Installation

Running npm install in the module's root directory will install everything you need for development.

Running Tests

npm test will run the tests once.
npm run test:coverage will run the tests and produce a coverage report in coverage/.
npm run test:watch will run the tests on every change.

Building

npm run build will build the module for publishing to npm.
npm run clean will delete built resources.