Talisman is a JavaScript library collecting series of algorithms related to the three following domains:
You can install Talisman through npm:
npm install talismanThe library's full documentation can be found here.
- 📦 Modular: the library is completely modular. This means that if you only need to compute a
levenshteindistance, you will only load the relevant code. - 💡 Straightfoward & simple: just want to compute a jaccard index? No need to instantiate a class and use two methods to pass options and then finally succeed in getting the index. Just apply the
jaccardfunction and get going. - 🍡 Consistent API: the library's API is fully consistent and one should not struggle to understand how to apply two different distance metrics.
- 📯 Functional: except for cases where classes might be useful (classifiers notably), Talisman only uses functions, consumes raw data and order functions' arguments to make partial application & currying etc. as easy as possible.
- ⚡ Performant: the library should be as performant as possible for a high-level programming language library.
- 🌐 Cross-platform: the library is cross-platform and can be used both with node.js and in the browser.
Contributions are of course welcome :)
Be sure to lint & pass the unit tests before submitting your pull request.
# Cloning the repo
git clone git@github.com:Yomguithereal/talisman.git
cd talisman
# Installing the deps
npm install
# Running the tests
npm test
# Linting the code
npm run lint