summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2012-12-10 20:39:56 -0700
committerRocky Madden <git@rockymadden.com>2012-12-10 20:39:56 -0700
commit41e3bf79e610f0e6c99ebeabd60d9af00fdc8aaa (patch)
tree07b291174c743048c3c551d23a2682e02be4d22a
parent19421dc672f411c1b9fe3b9b85a4e559cf4563a8 (diff)
downloadstringmetric-41e3bf79e610f0e6c99ebeabd60d9af00fdc8aaa.tar.gz
stringmetric-41e3bf79e610f0e6c99ebeabd60d9af00fdc8aaa.tar.bz2
stringmetric-41e3bf79e610f0e6c99ebeabd60d9af00fdc8aaa.zip
Added Maven Central Repository integration information.
-rwxr-xr-xreadme.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/readme.md b/readme.md
index bc715a0..b59f3a4 100755
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,5 @@
#stringmetric [![Build Status](https://secure.travis-ci.org/rockymadden/stringmetric.png)](http://travis-ci.org/rockymadden/stringmetric)
-A small library of string metrics and phonetic algorithms. Each has a command line interface, is thoroughly unit tested, and performant (verified via microbenchmark suites).
+A small library of string metrics and phonetic algorithms. Each has a command line interface, is thoroughly unit tested, and performant (verified via microbenchmark suites).
* __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.
@@ -20,12 +20,20 @@ A small library of string metrics and phonetic algorithms. Each has a command li
* __[Soundex](http://en.wikipedia.org/wiki/Soundex)__ (Phonetic metric and algorithm)
* __Weighted Levenshtein__ (Similarity metric)
-## Building the API
+## Depending on the API (via the [Maven Central Repository](http://search.maven.org/))
+* __groupId__: org.hashtree.stringmetric
+* __artifactId__: stringmetric-core
+
+## Depending on the CLI (via the [Maven Central Repository](http://search.maven.org/))
+* __groupId__: org.hashtree.stringmetric
+* __artifactId__: stringmetric-cli
+
+## Building the API (via Gradle)
```shell
gradle :stringmetric-core:jar
```
-## Building the CLI
+## Building the CLI (via Gradle)
```shell
gradle :stringmetric-cli:tar
```
@@ -103,7 +111,6 @@ metaphoneAlgorithm abc
* Gradle 1.x
## Todo
-* Maven central integration
* SmithWaterman
* MongeElkan
* NeedlemanWunch