updated README.md and Cargo metadata

Cargo.toml

@@ -2,6 +2,10 @@
 name = "stemmer"
 version = "0.1.0"
 authors = ["Elisabeth Henry <[email protected]>"]
+license = "BSD-2-Clause"
+readme = "README.md"
+homepage = "https://github.com/lady-segfault/stemmer-rs"
+repository = "https://github.com/lady-segfault/stemmer-rs"
 links = "stemmer"
 build = "build.rs"
 

README.md

@@ -1,3 +1,29 @@
 # stemmer-rs
 
-Stemming library for Rust, using bindings to Snowball C implementation (see http://snowball.tartarus.org/index.php) 
+Stemming library for Rust, using bindings to Snowball C implementation (see http://snowball.tartarus.org/)
+
+## Usage
+
+* `Stemmer::list()` returns a vector with all possible algorithms that
+can be used.
+* `Stemmer::new(algorithm)` creates a new Stemmer. Note that it
+returns an option, as it can fail if `algorithm` is not a valid one.
+* Once you have a `stemmer`, `stemmer.stem(word)` stems a word.
+
+Note that the C Stemming library (or at least the part that is used by
+the Rust bindings) is included and statically linked by the Rust
+bindings, so you don't have any other libraries to install when you
+use this Rust library.
+
+## Credits
+
+These are just Rust bindings for the Snowball C stemming library,
+written by Martin Porter. See http://snowball.tartarus.org/index.php
+for the Snowball project and
+http://snowball.tartarus.org/dist/libstemmer_c.tgz for the C version.
+
+## License
+
+The Rust bindings, as well as the original C implementation, is
+covered by the BSD license
+(http://opensource.org/licenses/bsd-license.html).