aboutsummaryrefslogtreecommitdiff
path: root/node_modules/leven/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/leven/readme.md')
-rw-r--r--node_modules/leven/readme.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/node_modules/leven/readme.md b/node_modules/leven/readme.md
new file mode 100644
index 0000000..33625c4
--- /dev/null
+++ b/node_modules/leven/readme.md
@@ -0,0 +1,50 @@
+# leven [![Build Status](https://travis-ci.org/sindresorhus/leven.svg?branch=master)](https://travis-ci.org/sindresorhus/leven)
+
+> Measure the difference between two strings<br>
+> One of the fastest JS implementations of the [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) algorithm
+
+
+## Install
+
+```
+$ npm install leven
+```
+
+
+## Usage
+
+```js
+const leven = require('leven');
+
+leven('cat', 'cow');
+//=> 2
+```
+
+
+## Benchmark
+
+```
+$ npm run bench
+```
+
+```
+ 165,926 op/s » leven
+ 164,398 op/s » talisman
+ 1,044 op/s » levenshtein-edit-distance
+ 628 op/s » fast-levenshtein
+ 497 op/s » levenshtein-component
+ 195 op/s » ld
+ 190 op/s » levenshtein
+ 168 op/s » levdist
+ 10 op/s » natural
+```
+
+
+## Related
+
+- [leven-cli](https://github.com/sindresorhus/leven-cli) - CLI for this module
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)