diff --git a/Cargo.toml b/Cargo.toml index 1069014b..a1feb7bf 100644 --- a/Cargo.toml +++ b/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 diff --git a/README.md b/README.md index 97599d36..d86bef03 100644 --- a/README.md +++ b/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 ) +* MIT license ([LICENSE-MIT](LICENSE-MIT) or ) -[`cargo fmt`]: https://github.com/rust-lang/rustfmt +at your option. [Documentation]: https://docs.rs/annotate-snippets/