summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-01-23 14:47:03 -0700
committerRocky Madden <git@rockymadden.com>2013-01-23 14:47:03 -0700
commit7cd7e2bd830c6b261d5f78a5a54c7d4012ac48aa (patch)
tree32d9d4014e15db7c5b583a638ea8da6cb980779c /readme.md
parent0b07e2dcc37bf82e038b3036c929b635adefb0d5 (diff)
downloadstringmetric-7cd7e2bd830c6b261d5f78a5a54c7d4012ac48aa.tar.gz
stringmetric-7cd7e2bd830c6b261d5f78a5a54c7d4012ac48aa.tar.bz2
stringmetric-7cd7e2bd830c6b261d5f78a5a54c7d4012ac48aa.zip
Added convenience section.
Diffstat (limited to 'readme.md')
-rwxr-xr-xreadme.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 4e4e23f..638d225 100755
--- a/readme.md
+++ b/readme.md
@@ -285,6 +285,14 @@ Basic example with stacked filter. Filters are applied in reverse order:
JaroWinklerMetric.compare("string1", "string2")(new StringFilterDelegate with AsciiLetterCaseStringFilter with AsciiLetterOnlyStringFilter)
```
+## Convenience objects
+The StringMetric, StringAlgorithm, and StringFilter convenience objects are available to make interactions with the library easier:
+```scala
+StringMetric.compareWithJaroWinkler("string1", "string2")
+StringMetric.compareWithJaroWinkler("string1", "string2")(StringFilter.asciiLetterCase)
+StringAlgorithm.computeWithMetaphone("string1", "string2")
+```
+
## Todo
* SmithWaterman
* MongeElkan