summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2012-10-16 00:12:06 -0600
committerRocky Madden <git@rockymadden.com>2012-10-16 00:12:06 -0600
commit61f2ddf07826d3b278eb17d31ffbb5bfdbdc56ca (patch)
tree33f01d986e03dc5143ce0a90d6074447b8338e6e /readme.md
parent509be5d66c6a5c83a636d1f0bc1bad183c2a723e (diff)
downloadstringmetric-61f2ddf07826d3b278eb17d31ffbb5bfdbdc56ca.tar.gz
stringmetric-61f2ddf07826d3b278eb17d31ffbb5bfdbdc56ca.tar.bz2
stringmetric-61f2ddf07826d3b278eb17d31ffbb5bfdbdc56ca.zip
Changed from package level implicit for stringCleaner to per metric based.
Diffstat (limited to 'readme.md')
-rwxr-xr-xreadme.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/readme.md b/readme.md
index 78bfe34..e0e2be9 100755
--- a/readme.md
+++ b/readme.md
@@ -13,10 +13,12 @@ gradle jar
gradle tar
## Using the API
-`// Import the metric of choice.`
-`import org.hashtree.stringmetric.JaroWinklerMetric`
+`// Import metric of choice.`
+`import org.hashtree.stringmetric.JaroWinklerMetric`
+`// Optionally import metric implicit stringCleaner into scope.`
+`import org.hashtree.stringmetric.JaroWinklerMetric.stringCleaner`
-`// Invoke the compare method on the metric.`
+`// Invoke metric compare method with implicit stringCleaner.`
`val distance = JaroWinklerMetric.compare("string1", "string2")`
`// Do something. In this case, distance is between 1.0f and 0.0f.`