summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-12-28 18:41:24 -0700
committerRocky Madden <git@rockymadden.com>2013-12-28 18:41:24 -0700
commit48f312a24dac8fc33ab58bcd3e9cf6557bebf473 (patch)
tree3b1789a19de46e2d9d6ba0bcf9bce43633d94a92
parentc42768673de38cf835f249f692a471456dedc75b (diff)
downloadstringmetric-48f312a24dac8fc33ab58bcd3e9cf6557bebf473.tar.gz
stringmetric-48f312a24dac8fc33ab58bcd3e9cf6557bebf473.tar.bz2
stringmetric-48f312a24dac8fc33ab58bcd3e9cf6557bebf473.zip
Removed type reference information.
-rwxr-xr-xreadme.md13
1 files changed, 0 insertions, 13 deletions
diff --git a/readme.md b/readme.md
index 7a276f0..f4cc67e 100755
--- a/readme.md
+++ b/readme.md
@@ -381,9 +381,6 @@ __StringAlgorithm:__
```scala
// Easy access to compute methods.
StringAlgorithm.computeWithMetaphone("string")
-
-// Easy access to types and companion objects.
-val metaphone: StringAlgorithm.Metaphone = StringAlgorithm.Metaphone()
```
---
@@ -392,20 +389,10 @@ __StringMetric:__
```scala
// Easy access to compare methods.
StringMetric.compareWithJaroWinkler("string1", "string2")
-
-// Easy access to types and companion objects.
-val jaro: StringMetric.Jaro = StringMetric.Jaro()
```
---
-__StringFilter:__
-```scala
-// Easy access to types and instances.
-val metaphone: StringAlgorithm.Metaphone = StringAlgorithm.Metaphone() with StringFilter.asciiSpace
-val asciiSpace: StringFilter.AsciiSpace = StringFilter.asciiSpace
-```
-
## Building the CLIs
When built, the CLI sub-project creates an individual shell command for each algorithm and metric. The sub-project is built via a Gradle task: