diff options
| -rwxr-xr-x | readme.md | 32 |
1 files changed, 22 insertions, 10 deletions
@@ -1,6 +1,8 @@ #stringmetric [](http://travis-ci.org/rockymadden/stringmetric) A Scala library of string metrics and phonetic algorithms. Each has a command line interface, is thoroughly unit tested, and performant (verified via microbenchmark suites). +__Concepts:__ + * __Similarity metrics__ determine the distance or coefficient between two arguments. * __Phonetic metrics__ determine if two arguments sound the same phonetically. * __Phonetic algorithms__ determine the phonetic representation of the argument passed. All phonetic metrics have a standalone algorithm counterpart. @@ -76,17 +78,15 @@ Get the phonetic representation of "abc" using the Metaphone phonetic algorithm: $ metaphoneAlgorithm abc ``` -## Depending on the API -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): +## Testing the API +```shell +$ gradle :stringmetric-core:test +``` -* __groupId__: com.rockymadden.stringmetric -* __artifactId__: stringmetric-cli +## Testing the CLI +```shell +$ gradle :stringmetric-cli:test +``` ## Building the API ```shell @@ -98,6 +98,18 @@ $ gradle :stringmetric-core:jar $ gradle :stringmetric-cli:tar ``` +## Depending on the API +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 |