Add some metadata

2 files changed, 19 insertions, 1 deletions

diff --git a/embassy-usb-synopsys-otg/Cargo.toml b/embassy-usb-synopsys-otg/Cargo.toml
index 5693acc38..b0562627b 100644
--- a/embassy-usb-synopsys-otg/Cargo.toml
+++ b/embassy-usb-synopsys-otg/Cargo.toml
@@ -2,12 +2,26 @@
 name = "embassy-usb-synopsys-otg"
 version = "0.1.0"
 edition = "2021"
+description = "`embassy-usb-driver` implementation for Synopsys OTG USB controllers"
+keywords = ["embedded", "async", "usb", "hal", "embedded-hal"]
+categories = ["embedded", "hardware-support", "no-std", "asynchronous"]
+repository = "https://github.com/embassy-rs/embassy"
+documentation = "https://docs.embassy.dev/embassy-usb-synopsys-otg"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+[package.metadata.embassy_docs]
+src_base = "https://github.com/embassy-rs/embassy/blob/embassy-usb-synopsys-otg-v$VERSION/embassy-usb-synopsys-otg/src/"
+src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-usb-synopsys-otg/src/"
+features = ["defmt"]
+target = "thumbv7em-none-eabi"
+
 [dependencies]
 critical-section = "1.1"
 futures = { version = "0.3.17", default-features = false }
 
 embassy-sync = { version = "0.5.0", path = "../embassy-sync" }
 embassy-usb-driver = {version = "0.1.0", path = "../embassy-usb-driver" }
+
+defmt = { version = "0.3", optional = true }
+log = { version = "0.4.14", optional = true }
diff --git a/embassy-usb-synopsys-otg/README.md b/embassy-usb-synopsys-otg/README.md
index c3f914896..fa8d5d6da 100644
--- a/embassy-usb-synopsys-otg/README.md
+++ b/embassy-usb-synopsys-otg/README.md
@@ -1 +1,5 @@
-# Embassy USB driver for the Synopsys OTG core
+# Embassy USB driver for the Synopsys USB OTG core
+
+This crate implements `embassy-usb-driver` for Synopsys USB OTG devices. If you wish to
+integrate this crate into your device's HAL, you will need to add device-specific initialization.
+For an example, check out the `embassy-stm32` crate.