From b6bc627b24e0ad3b2e8a45ddf9b34b32f5b2e780 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Tue, 23 Aug 2022 14:05:17 +0200 Subject: [PATCH] Add README for embassy-futures --- embassy-futures/README.md | 9 +++++++++ embassy-futures/src/lib.rs | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 embassy-futures/README.md diff --git a/embassy-futures/README.md b/embassy-futures/README.md new file mode 100644 index 000000000..971f4c835 --- /dev/null +++ b/embassy-futures/README.md @@ -0,0 +1,9 @@ +# embassy-futures + +Utilities for working with futures: + +- [`select`](select::select) - waiting for one out of two futures to complete. +- [`select3`](select::select3) - waiting for one out of three futures to complete. +- [`select4`](select::select4) - waiting for one out of four futures to complete. +- [`select_all`](select::select_all) - waiting for one future in a list of futures to complete. +- [`yield_now`](yield_now::yield_now) - yielding the current task. diff --git a/embassy-futures/src/lib.rs b/embassy-futures/src/lib.rs index 48c9c8574..45bea2529 100644 --- a/embassy-futures/src/lib.rs +++ b/embassy-futures/src/lib.rs @@ -1,5 +1,5 @@ #![no_std] -#![doc = include_str!("../../README.md")] +#![doc = include_str!("../README.md")] #![warn(missing_docs)] // This mod MUST go first, so that the others see its macros.