docs: add missing README for usb-logger

embassy-rs · Nov 21, 2022 · 06fb3e4 · 06fb3e4
1 parent a444a65
commit 06fb3e4
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/embassy-usb-logger/README.md b/embassy-usb-logger/README.md
@@ -0,0 +1,15 @@
+# embassy-usb-logger
+
+USB implementation of the `log` crate. This logger can be used by any device that implements `embassy-usb`. When running,
+it will output all logging done through the `log` facade to the USB serial peripheral.
+
+## Usage
+
+Add the following embassy task to your application. The `Driver` type is different depending on which HAL you use.
+
+ ```rust
+#[embassy_executor::task]
+async fn logger_task(driver: Driver<'static, USB>) {
+    embassy_usb_logger::run!(1024, log::LevelFilter::Info, driver);
+}
+```