API reference with usage examples available here.
To install all dev dependencies
To setup repository with documentation
npm run doc
This will build the documentation and open it in your browser.
To update .html files with documentation
npm run doc again.
To run tests
*.spec.js files will be executed.
To deploy documentation site
npm run deploy
This requires you to have commit access to your Git remote.
Fork the repo and make required changes. After that push your changes in branch, which is named according to the changes you did. Initiate the PR.
Make sure you're editor makes validations according to the
.jshintrc in the root directory of the repository.
Before pushing to the repository run:
If the build is not successful fix your code in order the tests and jshint validation to run successfully and after that create a pull request.
The code in this repository is distributed under the terms of the MIT license.