summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-01-08 11:18:30 -0700
committerRocky Madden <git@rockymadden.com>2013-01-08 11:18:30 -0700
commite5f996825d9ce6e3d12a093c063bf449e717e552 (patch)
tree0e61af5c8df09622a66a19eeeb9f62294a8493c6
parent42a82d68ab6bd634016a2d7bff323d48f8f51d36 (diff)
downloadstringmetric-e5f996825d9ce6e3d12a093c063bf449e717e552.tar.gz
stringmetric-e5f996825d9ce6e3d12a093c063bf449e717e552.tar.bz2
stringmetric-e5f996825d9ce6e3d12a093c063bf449e717e552.zip
Complete revamp of introduction, which includes a visual overview.
-rwxr-xr-xreadme.md9
1 files changed, 2 insertions, 7 deletions
diff --git a/readme.md b/readme.md
index 9cb7c50..c7f7dfc 100755
--- a/readme.md
+++ b/readme.md
@@ -1,12 +1,7 @@
#stringmetric [![Build Status](https://secure.travis-ci.org/rockymadden/stringmetric.png)](http://travis-ci.org/rockymadden/stringmetric)
-A Scala library of string metrics and phonetic algorithms. Each has a command line interface, is thoroughly unit tested, and performant (verified via microbenchmark suites).
+A Scala library of string metrics and phonetic algorithms. It provides implementations to perform approximate string matching, fuzzy searching, measurement of string similarity and/or dissimilarity, word pronounciation, and more. Common applications of said metrics and algorithms include spell checkers, search functionality, plagirism detection, fraud detection, data deduplication, and data mining. In addition to the core library, each metric and algorithm has a command line interface, is thoroughly unit tested, and performant (verified via microbenchmark suites).
-__Concepts:__
-
-* __Similarity metrics__ determine the distance or coefficient between two arguments.
-* __Phonetic metrics__ determine if two arguments sound the same phonetically.
-* __Phonetic algorithms__ determine the phonetic representation of the argument passed. All phonetic metrics have a standalone algorithm counterpart.
-* __Filters__ clean up arguments prior to evaluation. Filters can be combined via trait stacking.
+![stringmetric](http://dl.dropbox.com/u/51819310/stringmetric.png)
## Metrics and Algorithms
* __[Dice / Sorensen](http://en.wikipedia.org/wiki/Dice%27s_coefficient)__ (Similarity metric)