Deddd documentation links

mbrlabs · Jun 27, 2016 · 5dc8c47 · 5dc8c47
1 parent bd7befa
commit 5dc8c47
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -7,6 +7,7 @@ description = "A collection of approximate string matching algorithms"
 keywords = ["search", "text", "string", "matching", "levenshtein"]
 repository = "https://github.com/mbrlabs/distance"
 homepage = "https://github.com/mbrlabs/distance"
+documentation = "https://mbrlabs.github.io/distance"
 readme = "README.md"
 license = "Apache-2.0"
 publish = false

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 [![](https://travis-ci.org/mbrlabs/distance.svg?branch=master)](https://travis-ci.org/mbrlabs/distance) 
 [![](https://img.shields.io/crates/v/distance.svg)](https://crates.io/crates/distance)
 
-This is a rust library for approximate string matching algorithms.
+This is a rust library for approximate string matching algorithms.   
 Possible applications for this are fuzzy string searching, spell checkers, spam filters, etc.
 
 ## Algorithms
@@ -17,11 +17,12 @@ distance = "0.1"
 ```
 
 ## Usage
-
 ```rust
 use distance::*; 
 
 // Levenshtein distance
 let distance = levenshtein("kitten", "sitting");   
 assert_eq!(distance, 3);
-```
+```
+
+You can also take a look at the [documentation](https://mbrlabs.github.io/distance)