diff --git a/README.md b/README.md index dce29d8..743b235 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,29 @@ The levenshtein distance between two strings is defined as the minimum number of This implementation is optimized to use O(min(m,n)) space. It is based on the optimized C version found [here](http://en.wikibooks.org/wiki/Algorithm_implementation/Strings/Levenshtein_distance#C) + + +## Install +``` +go get github.com/Darklabel91/Levenshtein +``` + +## Example +```go +package main + +import ( + "fmt" + "github.com/Darklabel91/Levenshtein" +) + +func main() { + levenshtein := Levenshtein.Distance("Daniel", "Danilo") + fmt.Println(levenshtein) +} + +``` +Return +``` +2 +```