summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-02-11 14:35:34 -0700
committerRocky Madden <git@rockymadden.com>2013-02-11 14:35:34 -0700
commitd7c64cfa99a6ac3a7428c0840e61f4c7e496cba1 (patch)
tree8337b700ff24e8145594d55fb48c249c02df53bb /readme.md
parentbe28fca736f2bc7623b6ab6773a90ae113a93caf (diff)
downloadstringmetric-d7c64cfa99a6ac3a7428c0840e61f4c7e496cba1.tar.gz
stringmetric-d7c64cfa99a6ac3a7428c0840e61f4c7e496cba1.tar.bz2
stringmetric-d7c64cfa99a6ac3a7428c0840e61f4c7e496cba1.zip
Trait and convenience object tweaks. Took notes from the scala library collection packages.
Diffstat (limited to 'readme.md')
-rwxr-xr-xreadme.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/readme.md b/readme.md
index 3eb9240..6742305 100755
--- a/readme.md
+++ b/readme.md
@@ -23,8 +23,8 @@ Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga
* __artifactId__: stringmetric-core
* __artifactId__: stringmetric-cli
-## Generated Documentation
-[Scaladoc](http://rockymadden.com/stringmetric/scaladoc/) is available on the project website.
+## Docs
+[Scaladoc](http://rockymadden.com/stringmetric/scaladoc/) is available on the project website.
## Similarity package
Useful for approximate string matching and measurement of string distance. Most metrics calculate the similarity of two strings as a double with a value between 0 and 1. A value of 0 being completely different and a value of 1 being completely similar.
@@ -289,10 +289,10 @@ Basic example with stacked filter. Filters are applied in reverse order:
```
## Convenience objects
-The StringMetricLike, StringAlgorithmLike, and StringFilterLike standalone convenience objects are available to make interactions with the library easier:
+The StringMetric, StringAlgorithm, StringFilter, ConfigurableStringAlgorithm, and ConfigurableStringMetric standalone convenience objects are available to make interactions with the library easier:
```scala
-StringMetricLike.compareWithJaroWinkler("string1", "string2")
-StringAlgorithmLike.computeWithMetaphone("string1", "string2")
+StringMetric.compareWithJaroWinkler("string1", "string2")
+StringAlgorithm.computeWithMetaphone("string1", "string2")
```
## Command line interfaces