Merge pull request #291 from epage/docs

docs(readme): Clean up README

Author: epage

Cargo.toml

@@ -97,7 +97,7 @@ lto = true
 [package]
 name = "annotate-snippets"
 version = "0.12.1"
-description = "Library for building code annotations"
+description = "Format diagnostic reports, including highlighting snippets of text"
 categories = []
 keywords = ["code", "analysis", "ascii", "errors", "debug"]
 repository.workspace = true

README.md

@@ -1,27 +1,20 @@
 # annotate-snippets
 
-`annotate-snippets` is a Rust library for annotation of programming code slices.
+> Format diagnostic reports, including highlighting snippets of text
 
 [![crates.io](https://img.shields.io/crates/v/annotate-snippets.svg)](https://crates.io/crates/annotate-snippets)
 [![documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
 ![build status](https://github.com/rust-lang/annotate-snippets-rs/actions/workflows/ci.yml/badge.svg)
 
-The library helps visualize meta information annotating source code slices.
-It takes a data structure called `Snippet` on the input and produces a `String`
-which may look like this:
-
 ![Screenshot](./examples/expected_type.svg)
 
-Local Development
------------------
+## License
 
-```console
-$ cargo build
-$ cargo test
-```
+Licensed under either of
 
-When submitting a PR please use  [`cargo fmt`][] (nightly).
+* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
+* MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/license/mit>)
 
-[`cargo fmt`]: https://github.com/rust-lang/rustfmt
+at your option.
 
 [Documentation]: https://docs.rs/annotate-snippets/