From 7d1257caa055f4ad1b5fa54c9fe28d7f3bc5c5f6 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Fri, 12 Jan 2024 09:17:26 +0100 Subject: [PATCH] docs: add readme --- embassy-stm32-wpan/Cargo.toml | 5 +++++ embassy-stm32-wpan/src/lib.rs | 2 ++ 2 files changed, 7 insertions(+) diff --git a/embassy-stm32-wpan/Cargo.toml b/embassy-stm32-wpan/Cargo.toml index ef85ecac8..4f53a400a 100644 --- a/embassy-stm32-wpan/Cargo.toml +++ b/embassy-stm32-wpan/Cargo.toml @@ -3,6 +3,11 @@ name = "embassy-stm32-wpan" version = "0.1.0" edition = "2021" license = "MIT OR Apache-2.0" +description = "Async STM32 WPAN stack for embedded devices in Rust." +keywords = ["embedded", "async", "stm32", "ble", "wpan"] +categories = ["embedded", "hardware-support", "no-std", "asynchronous"] +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-stm32-wpan" [package.metadata.embassy_docs] src_base = "https://github.com/embassy-rs/embassy/blob/embassy-stm32-wpan-v$VERSION/embassy-stm32-wpan/src/" diff --git a/embassy-stm32-wpan/src/lib.rs b/embassy-stm32-wpan/src/lib.rs index a5dbb7420..f9560d235 100644 --- a/embassy-stm32-wpan/src/lib.rs +++ b/embassy-stm32-wpan/src/lib.rs @@ -1,5 +1,7 @@ #![no_std] #![allow(async_fn_in_trait)] +#![doc = include_str!("../README.md")] +// #![warn(missing_docs)] // This must go FIRST so that all the other modules see its macros. mod fmt;