API reference with usage examples available here.
Note: not all algorithms are well tested so bugs are quite possible.
To install all dev dependencies
To setup repository with documentation
- Go to the parent directory of the
- Go to the
git checkout gh-pages
Now you can see
index.html file in this folder and open it in your browser.
To update .html files with documentation
Go to the
and all files in
To run tests
*.spec.js files will be executed.
Fork the repo and make requred 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.