From cf7da1c2bb4913c377633f004a5b3d8008a3c170 Mon Sep 17 00:00:00 2001
From: Dario Nieuwenhuis <dirbaio@dirbaio.net>
Date: Thu, 11 Jan 2024 21:05:09 +0100
Subject: [PATCH] embassy-embedded-hal: add README.

---
 embassy-embedded-hal/README.md  | 12 ++++++++++++
 embassy-embedded-hal/src/lib.rs |  3 +--
 2 files changed, 13 insertions(+), 2 deletions(-)
 create mode 100644 embassy-embedded-hal/README.md

diff --git a/embassy-embedded-hal/README.md b/embassy-embedded-hal/README.md
new file mode 100644
index 00000000..69581c78
--- /dev/null
+++ b/embassy-embedded-hal/README.md
@@ -0,0 +1,12 @@
+# embassy-embedded-hal
+
+Collection of utilities to use `embedded-hal` and `embedded-storage` traits with Embassy.
+
+- Shared SPI and I2C buses, both blocking and async, with a `SetConfig` trait allowing changing bus configuration (e.g. frequency) between devices on the same bus.
+- Async utilities
+    - Adapters to convert from blocking to (fake) async.
+    - Adapters to insert yields on trait operations.
+- Flash utilities
+    - Split a flash memory into smaller partitions.
+    - Concatenate flash memories together.
+    - Simulated in-memory flash.
diff --git a/embassy-embedded-hal/src/lib.rs b/embassy-embedded-hal/src/lib.rs
index ee974324..99a2d93c 100644
--- a/embassy-embedded-hal/src/lib.rs
+++ b/embassy-embedded-hal/src/lib.rs
@@ -1,8 +1,7 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 #![allow(async_fn_in_trait)]
 #![warn(missing_docs)]
-
-//! Utilities to use `embedded-hal` traits with Embassy.
+#![doc = include_str!("../README.md")]
 
 pub mod adapter;
 pub mod flash;