From 02e5d9485974e7bd36649ae7b6d972b5c0be4fd6 Mon Sep 17 00:00:00 2001
From: matthieugomez <gomez.matthieu@gmail.com>
Date: Thu, 22 Oct 2015 12:27:52 -0400
Subject: [PATCH] task

---
 README.md | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 6b4543a..4375cd2 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,20 @@
 # StringDistances
 String Distances in Julia
 
-- Hamming Distance
-- Jaro distance
-- Jaro-Winkler Distance. Options are `p` (scaling factor), `b` (boosting parameter), and `minlen` (minimum length for long string adjustment)
-- Levenshtein distance
+-[x] Hamming Distance
+-[x] Jaro distance
+-[x] Jaro-Winkler Distance
+-[x] Levenshtein distance
+-[] Damerau-Levenshtein Distance
+-[] qgram
 
 
-To be implemented
-- Damerau-Levenshtein Distance
-- qgram
\ No newline at end of file
+Examples
+```julia
+using StringDistances
+hamming("MARTHA", "MARHTA")
+levenshtein("MARTHA", "MARHTA")
+jaro("MARTHA", "MARHTA")
+jaro_winkler("MARTHA", "MARHTA"; scaling_factor = 0.1, boosting_threshold = 0.7, long_threshold = 5)
+```
+