diff options
| author | Rocky Madden <git@rockymadden.com> | 2013-01-08 09:46:30 -0700 |
|---|---|---|
| committer | Rocky Madden <git@rockymadden.com> | 2013-01-08 09:46:30 -0700 |
| commit | 42a82d68ab6bd634016a2d7bff323d48f8f51d36 (patch) | |
| tree | 50d01075178455047860b772ebfab3c9ef76f844 /readme.md | |
| parent | b9d4f7be18cf01c64c9313500ccbdd0863fa7e1f (diff) | |
| download | stringmetric-42a82d68ab6bd634016a2d7bff323d48f8f51d36.tar.gz stringmetric-42a82d68ab6bd634016a2d7bff323d48f8f51d36.tar.bz2 stringmetric-42a82d68ab6bd634016a2d7bff323d48f8f51d36.zip | |
Combined sections.
Diffstat (limited to 'readme.md')
| -rwxr-xr-x | readme.md | 31 |
1 files changed, 14 insertions, 17 deletions
@@ -22,7 +22,7 @@ __Concepts:__ * __[Soundex](http://en.wikipedia.org/wiki/Soundex)__ (Phonetic metric and algorithm) * __Weighted Levenshtein__ (Similarity metric) -## Using the API +## Using the Core Basic example with no filtering: ```scala val distance = JaroWinklerMetric.compare("string1", "string2") @@ -78,42 +78,45 @@ Get the phonetic representation of "abc" using the Metaphone phonetic algorithm: $ metaphoneAlgorithm abc ``` -## Testing the API +## Testing ```shell $ gradle :stringmetric-core:test ``` -## Testing the CLI +and + ```shell $ gradle :stringmetric-cli:test ``` -## Building the API +## Building ```shell $ gradle :stringmetric-core:jar ``` -## Building the CLI +and + ```shell $ gradle :stringmetric-cli:tar ``` -## Depending on the API +## Depending Upon Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.rockymadden.stringmetric%22): * __groupId__: com.rockymadden.stringmetric * __artifactId__: stringmetric-core - -## Depending on the CLI -Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.rockymadden.stringmetric%22): - -* __groupId__: com.rockymadden.stringmetric * __artifactId__: stringmetric-cli ## Requirements * Scala 2.9.x * Gradle 1.x +## Versioning +[Semantic Versioning v2.0](http://semver.org/) + +## License +[Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0) + ## Todo * Scala 2.10.x * SmithWaterman @@ -123,11 +126,5 @@ Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga * Double Metaphone * Memoization decorator -## Versioning -[Semantic Versioning v2.0](http://semver.org/) - -## License -[Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0) - ## Questions and Comments Reach me at <stringmetric@rockymadden.com>.
\ No newline at end of file |