Add package metadata (#3)

bash · Jan 20, 2024 · 990a520 · 990a520
2 parents 0ede6c5 + de4baec
commit 990a520
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,14 @@
 [package]
 name = "terminal-trx"
+description = "Provides a handle to the terminal of the current process"
+readme = "readme.md"
+repository = "https://github.com/bash/terminal-trx"
+categories = ["command-line-interface"]
+license = "MIT OR Apache-2.0"
 version = "0.1.0"
 edition = "2021"
+rust-version = "1.70.0"
+exclude = [".github", ".gitignore", "*.sh"]
 
 [dependencies]
 thiserror = "1.0.56"

diff --git a/readme.md b/readme.md
@@ -1,5 +1,8 @@
 # terminal-trx
 
+[![Docs](https://img.shields.io/docsrs/terminal-trx/latest)](https://docs.rs/terminal-trx)
+[![Crate Version](https://img.shields.io/crates/v/terminal-trx)](https://crates.io/crates/terminal-trx)
+
 Provides a handle to the terminal of the current process that is both readable and writable.
 
 ## Example
@@ -16,6 +19,8 @@ let mut line = String::new();
 reader.read_line(&mut line).unwrap();
 ```
 
+## [Docs](https://docs.rs/terminal-trx)
+
 ## Wishlist
 These are some features that I would like to include in this crate,
 but have not yet had the time to implement. Anyone is welcome to create a PR :)