Add a readme to uefi-macros

rust-osdev · Aug 23, 2021 · 5423d20 · 5423d20
1 parent d289e0c
commit 5423d20
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/uefi-macros/Cargo.toml b/uefi-macros/Cargo.toml
@@ -2,6 +2,7 @@
 name = "uefi-macros"
 version = "0.3.3"
 authors = ["Hadrien G. <[email protected]>"]
+readme = "README.md"
 edition = "2018"
 description = "Procedural macros for the uefi-rs crate"
 repository = "https://github.com/rust-osdev/uefi-rs"

diff --git a/uefi-macros/README.md b/uefi-macros/README.md
@@ -0,0 +1,7 @@
+# uefi-macros
+
+[![Crates.io](https://img.shields.io/crates/v/uefi-macros)](https://crates.io/crates/uefi-macros)
+[![Docs.rs](https://docs.rs/uefi-macros/badge.svg)](https://docs.rs/uefi-macros)
+
+This crate provides procedural macros used by [the `uefi-rs` project](https://github.com/rust-osdev/uefi-rs/)
+to simplify the development of UEFI applications and reduce boilerplate.