summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-01-23 13:41:49 -0700
committerRocky Madden <git@rockymadden.com>2013-01-23 13:41:49 -0700
commit5f29153d64d484728cdb4360422bf0a5aebc8424 (patch)
treeb6622d4b00a244df217d6e94b511188455e5879f /readme.md
parent51b619fc868e67e388f7d8078a895a0c4f46a256 (diff)
downloadstringmetric-5f29153d64d484728cdb4360422bf0a5aebc8424.tar.gz
stringmetric-5f29153d64d484728cdb4360422bf0a5aebc8424.tar.bz2
stringmetric-5f29153d64d484728cdb4360422bf0a5aebc8424.zip
Bolded example heading and changed outputs to output.
Diffstat (limited to 'readme.md')
-rwxr-xr-xreadme.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/readme.md b/readme.md
index 057bd32..eac10f5 100755
--- a/readme.md
+++ b/readme.md
@@ -19,13 +19,13 @@ String metrics and phonetic algorithms implemented in Scala. The library provide
## 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.
-Dice / Sorensen Metric:
+__Dice / Sorensen Metric:__
```scala
println(DiceSorensenMetric.compare("night", "nacht"))
println(DiceSorensenMetric.compare("context", "contact")
```
-Outputs:
+Output:
```shell
0.6
0.7142857142857143