Add a specific README for the macros crate

tracel-ai · Aug 27, 2024 · 0a37df0 · 0a37df0
1 parent c12179b
commit 0a37df0
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/tracel-xtask-macros/Cargo.toml b/crates/tracel-xtask-macros/Cargo.toml
@@ -6,6 +6,7 @@ keywords = ["xtask", "macros"]
 edition.workspace = true
 license.workspace = true
 name = "tracel-xtask-macros"
+readme = "README.md"
 repository = "https://github.com/tracel-ai/xtask/crates/tracel-xtask-macros"
 version.workspace = true
 rust-version = "1.79"

diff --git a/crates/tracel-xtask-macros/README.md b/crates/tracel-xtask-macros/README.md
@@ -0,0 +1,3 @@
+# Tracel Xtask Macros
+
+This crate implements the macros used by the [tracel-xtask](https://crates.io/crates/tracel-xtask) crate.