Various doc amendements

Yomguithereal · Mar 19, 2020 · 619699f · 619699f
1 parent 7039da2
commit 619699f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.0
+
+* Dropping some namespaces & consolidating a stable release.
+
 ## 0.21.0
 
 * Exposing Punkt Trainer's configuration options.

diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Guillaume Plique (Yomguithereal)
+Copyright (c) 2016-2020 Guillaume Plique (Yomguithereal)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -4,12 +4,7 @@
 
 [Full documentation](http://yomguithereal.github.io/talisman/)
 
-Talisman is a JavaScript library collecting series of algorithms related to the following domains:
-
-* [Statistics](https://en.wikipedia.org/wiki/Statistics)
-* [Fuzzy logic & fuzzy matching](https://en.wikipedia.org/wiki/Approximate_string_matching)
-* [Natural Language Processing](https://en.wikipedia.org/wiki/Natural_language_processing)
-* [Machine learning](https://en.wikipedia.org/wiki/Machine_learning)
+Talisman is a JavaScript library collecting algorithms, functions and various building blocks for [fuzzy matching](https://en.wikipedia.org/wiki/Approximate_string_matching), [information retrieval](https://en.wikipedia.org/wiki/Information_retrieval) and [natural language processing](https://en.wikipedia.org/wiki/Natural_language_processing).
 
 ## Installation
 
@@ -28,7 +23,7 @@ The library's full documentation can be found [here](http://yomguithereal.github
 * :package: **Modular**: the library is completely modular. This means that if you only need to compute a `levenshtein` distance, you will only load the relevant code.
 * :bulb: **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 `jaccard` function and get going.
 * :dango: **Consistent API**: the library's API is fully consistent and one should not struggle to understand how to apply two different distance metrics.
-* :postal_horn: **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.
+* :postal_horn: **Functional**: except for cases where classes might be useful (clustering notably), *Talisman* only uses functions, consumes raw data and order functions' arguments to make partial application & currying etc. as easy as possible.
 * :zap: **Performant**: the library should be as performant as possible for a high-level programming language library.
 * :globe_with_meridians: **Cross-platform**: the library is cross-platform and can be used both with Node.js and in the browser.
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "talisman",
   "version": "0.21.0",
-  "description": "A straightforward & modular NLP, machine learning & fuzzy matching library for JavaScript.",
+  "description": "Straightforward fuzzy matching, information retrieval and nlp building blocks for JavaScript.",
   "main": "index.js",
   "scripts": {
     "check": "npm test && npm run lint",