Update readme and cargo metadata

Cargo.toml

@@ -4,8 +4,10 @@ version = "0.1.0"
 authors = ["Armin Ronacher <armin.ronacher@active-4.com>", "Pierre-Étienne Meunier <pe@pijul.org>"]
 edition = "2018"
 license = "Apache-2.0"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+description = "A diff library for Rust"
+repository = "https://github.com/mitsuhiko/similar"
+keywords = ["diff", "difference", "udiff", "compare", "changes"]
+readme = "README.md"
 
 [dev-dependencies]
 insta = "1.5.2"

README.md

@@ -0,0 +1,20 @@
+# similar
+
+[![Build Status](https://github.com/mitsuhiko/similar/workflows/Tests/badge.svg?branch=master)](https://github.com/mitsuhiko/similar/actions?query=workflow%3ATests)
+[![Crates.io](https://img.shields.io/crates/d/similar.svg)](https://crates.io/crates/similar)
+[![License](https://img.shields.io/github/license/mitsuhiko/similar)](https://github.com/mitsuhiko/similar/blob/master/LICENSE)
+[![Documentation](https://docs.rs/similar/badge.svg)](https://docs.rs/similar)
+
+Similar is a dependency free crate for Rust that implements different diffing
+algorithms and high level interfaces for it.
+
+It provides both low level implementations of Myer's and the Patience diff
+algorithm as well as high level text diffing utilities (such as the ability
+to generate unified diffs).
+
+## License and Links
+
+- [Documentation](https://docs.rs/similar/)
+- [Issue Tracker](https://github.com/mitsuhiko/similar/issues)
+- License: [Apache-2.0](https://github.com/mitsuhiko/similar/blob/master/LICENSE)
+

src/lib.rs

@@ -1,5 +1,6 @@
 //! This crate implements diffing utilities.  It attempts to provide an abstraction
-//! interface over different types of diffing algorithms.
+//! interface over different types of diffing algorithms.  It's based on the
+//! the diff algorithm implementations of [pijul](https://pijul.org/).
 //!
 //! The crate is split into two levels:
 //!