Prepare release v0.1

Author: mbrlabs

AUTHORS

@@ -0,0 +1,10 @@
+# This is the official list of the AUTHORS of "distance"
+# for copyright purposes.
+# This file is distinct from the CONTRIBUTORS files.
+# See the latter for an explanation.
+
+# Names should be added to this file as
+#   Name or Organization <email address>
+# The email address is not required for organizations.
+
+Marcus Brummer <mbrlabs7@gmail.com>

CHANGES

@@ -0,0 +1,4 @@
+[0.1.0] ~ 28/06/2016
+- Initial release
+- Added the Levenshtein distance algorithm
+- Added tests for the Levenshtein distance algorithm

CONTRIBUTORS

@@ -0,0 +1,9 @@
+# This is the official list of people who can contribute
+# (and who have contributed) code to the "distance" project
+# repository.
+# The AUTHORS file lists the copyright holders; this file
+# lists people. Contributors must sign the CLA to grant
+# the AUTHORS copyright within the terms of the Apache 2 license.
+#
+
+mbrlabs     https://github.com/mbrlabs

Cargo.toml

@@ -3,9 +3,19 @@ name = "distance"
 version = "0.1.0"
 authors = ["Marcus Brummer <mbrlabs7@gmail.com>"]
 
-keywords = ["string matching", "string", "matching", "levenshtein"]
+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"
 readme = "README.md"
 license = "Apache-2.0"
+publish = false
 
-[dependencies]
+include = [
+    "**/*.rs",
+    "Cargo.toml",
+    "LICENCE",
+    "AUTHORS",
+    "CONTRIBUTORS",
+    "CHANGES",
+]

README.md

@@ -1,10 +1,23 @@
-# distance [![](https://travis-ci.org/mbrlabs/distance.svg?branch=master)](https://travis-ci.org/mbrlabs/distance)
+# distance 
+[![](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.
+Possible applications for this are fuzzy string searching, spell checkers, spam filters, etc.
 
 ## Algorithms
 - [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance)
 
+## Add as dependency
+distance is available on [crates.io](https://crates.io/crates/distance).
+
+```toml
+[dependencies]
+distance = "0.1"
+```
+
 ## Usage
+
 ```rust
 use distance::*; 
 

src/levenshtein.rs

@@ -1,9 +1,23 @@
+// Copyright (c) 2016. See AUTHORS file.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 use std::cmp;
 
 /// # Levenshtein distance
 /// 
 /// The [Levenshtein distance]((https://en.wikipedia.org/wiki/Levenshtein_distance)) is the number of per-character changes (insertion, deletion & substitution)
-/// one string differs from annother.
+/// that are neccessary to convert one string into annother.
 ///
 /// ## Examples
 /// ```

src/lib.rs

@@ -1,6 +1,20 @@
+// Copyright (c) 2016. See AUTHORS file.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 //! # A collection of approximate string matching algorithms 
 //!
-//! This library contains algorithms for approximate string matching.
+//! This library contains algorithms dealing with approximate string matching.
 //! These algorithms can be used to tell the approximate difference between two 
 //! strings. This is usful for a varity of things like spell checking, fuzzy search, etc.
 //! 
@@ -13,5 +27,4 @@
 //!
 
 pub use self::levenshtein::*;
-
 mod levenshtein;