From 67732cb0d827c915933e03e52c57517673918066 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Tue, 2 Sep 2025 16:44:49 -0500 Subject: [PATCH 1/3] docs(readme): Be consistent in project description This takes from `lib.rs` and spreads it around --- Cargo.toml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) 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..5ffe8b47 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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] From 781a5886e7121cb4f3e671b47b01fb7e1477ffee Mon Sep 17 00:00:00 2001 From: Ed Page Date: Tue, 2 Sep 2025 16:45:37 -0500 Subject: [PATCH 2/3] docs(readme): Be a bit more minimal in the README The dev workflow is fairly common. The description is relatively redundant. The big seller is the screenshot. Maybe we add a slice of code at some point. --- README.md | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/README.md b/README.md index 5ffe8b47..e9d6d494 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,6 @@ [![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 ------------------ - -```console -$ cargo build -$ cargo test -``` - -When submitting a PR please use [`cargo fmt`][] (nightly). - -[`cargo fmt`]: https://github.com/rust-lang/rustfmt - [Documentation]: https://docs.rs/annotate-snippets/ From 865531050212bfab21b77e256bb1f962b1c1e618 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Tue, 2 Sep 2025 16:46:46 -0500 Subject: [PATCH 3/3] docs(readme): Call out licenses --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index e9d6d494..d86bef03 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,13 @@ ![Screenshot](./examples/expected_type.svg) +## License + +Licensed under either of + +* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or ) +* MIT license ([LICENSE-MIT](LICENSE-MIT) or ) + +at your option. + [Documentation]: https://docs.rs/annotate-snippets/