tlks.io : librank
tlks.io ranking algorithm library
Table of contents
- Quick start
- Documentation
- Build status
- Bugs and feature requests
- Contributing
- Versioning
- Creators
- Copyright and license
Quick Start
You need node.js installed:
$ git clone http://github.com/tlksio/librank
$ cd librank
$ npm install
$ make test
Documentation
Please check the whole Project Documentation repo at: tlks.io documentation
Build status
Bugs and feature requests
Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.
Contributing
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
Moreover, if your pull request contains patches or features, you must include relevant unit tests.
Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.
Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, librank is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.
Creators
Raül Pérez
Copyright and License
Code and documentation copyright 2015 tlks.io authors.
Code released under the MIT license.