summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlf Lilleengen <lulf@redhat.com>2022-06-15 09:06:18 +0200
committerUlf Lilleengen <lulf@redhat.com>2022-06-15 09:06:18 +0200
commitf8f56c926df1c3b645b24b978404ef2303f60d0e (patch)
tree37f05540fa4b3ceedd5b88011f2ddbf656fc13e5
parent746bc75a8ec2576548b9ce5a956b0960d9c00737 (diff)
downloadembassy-f8f56c926df1c3b645b24b978404ef2303f60d0e.zip
Include README.md in crate documentation
-rw-r--r--README.md4
-rw-r--r--embassy/src/lib.rs1
2 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md
index f9b7486b..bb6e41c6 100644
--- a/README.md
+++ b/README.md
@@ -145,8 +145,8 @@ EMBedded ASYnc! :)
This work is licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
- http://www.apache.org/licenses/LICENSE-2.0)
-- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+ <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
at your option.
diff --git a/embassy/src/lib.rs b/embassy/src/lib.rs
index 1b6ff2d4..c3b2726a 100644
--- a/embassy/src/lib.rs
+++ b/embassy/src/lib.rs
@@ -1,6 +1,7 @@
#![cfg_attr(not(any(feature = "std", feature = "wasm")), no_std)]
#![cfg_attr(feature = "nightly", feature(generic_associated_types, type_alias_impl_trait))]
#![allow(clippy::new_without_default)]
+#![doc = include_str!("../../README.md")]
// This mod MUST go first, so that the others see its macros.
pub(crate) mod fmt;