Created repository.v0.0.0

1 files changed, 29 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100755
index 0000000..492a179
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,29 @@
+#stringmetric
+A collection of string metrics built with Scala. Includes a light-weight core API and CLI based interface for each string metric. The following string metrics are currently supported:
+
+* Jaro-Winkler
+
+## Building the API
+gradle jar
+
+## Building the CLI
+gradle tar
+
+## Using the API
+`// Import the metric of choice.`  
+`import org.hashtree.stringmetric.JaroWinklerMetric`
+
+`// Invoke the compare method on the metric.`  
+`val distance = JaroWinklerMetric.compare("string1", "string2")`
+
+`// Do something. In this case, distance is between 1.0f and 0.0f.`  
+`if (distance >= 0.9) println("It's likely you're a match!")`
+
+## Using the CLI
+Uncompress the built tar and ensure you have ability to execute the commands. Execute the metric of choice via the command line:
+
+`jaroWinklerMetric --help`  
+`jaroWinklerMetric abc xyz`
+
+## Requirements
+* Scala 2.9.2
\ No newline at end of file