summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-03-07 11:58:05 -0700
committerRocky Madden <git@rockymadden.com>2013-03-07 11:58:05 -0700
commitae42053134612a42ba8fd3b87aa9b680cc48b1f6 (patch)
tree88946a32ef9da75cd6cd70c8ee1c0aa35bf26826
parent55a9d5626285c833f2adb53da254ddcc51d66f21 (diff)
downloadstringmetric-ae42053134612a42ba8fd3b87aa9b680cc48b1f6.tar.gz
stringmetric-ae42053134612a42ba8fd3b87aa9b680cc48b1f6.tar.bz2
stringmetric-ae42053134612a42ba8fd3b87aa9b680cc48b1f6.zip
Expanded on installation section.
-rwxr-xr-xreadme.md27
1 files changed, 21 insertions, 6 deletions
diff --git a/readme.md b/readme.md
index 6742305..c0de985 100755
--- a/readme.md
+++ b/readme.md
@@ -17,14 +17,29 @@ String metrics and phonetic algorithms for Scala. The library provides facilitie
* __Weighted Levenshtein__ (Similarity metric)
## Installation
-Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.rockymadden.stringmetric%22):
+Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.rockymadden.stringmetric%22). Depending on the core sub-project shown below (add others, like the CLI, as needed):
-* __groupId__: com.rockymadden.stringmetric
-* __artifactId__: stringmetric-core
-* __artifactId__: stringmetric-cli
+### SBT
+```scala
+libraryDependencies += "com.rockymadden.stringmetric" % "stringmetric-core" % "0.22.2"
+```
+
+### Gradle
+```groovy
+compile 'com.rockymadden.stringmetric:stringmetric-core:0.22.2'
+```
+
+### Maven
+```xml
+<dependency>
+ <artifactId>com.rockymadden.stringmetric</artifactId>
+ <groupId>stringmetric-core</groupId>
+ <version>0.22.2</version>
+</dependency>
+```
-## Docs
-[Scaladoc](http://rockymadden.com/stringmetric/scaladoc/) is available on the project website.
+## Scaladocs
+[Scaladocs](http://rockymadden.com/stringmetric/scaladoc/) are available on the project website.
## Similarity package
Useful for approximate string matching and measurement of string distance. Most metrics calculate the similarity of two strings as a double with a value between 0 and 1. A value of 0 being completely different and a value of 1 being completely similar.