Add README for embassy-futures

This commit is contained in:
Ulf Lilleengen 2022-08-23 14:05:17 +02:00
parent 189d4137cc
commit b6bc627b24
2 changed files with 10 additions and 1 deletions

View File

@ -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.

View File

@ -1,5 +1,5 @@
#![no_std] #![no_std]
#![doc = include_str!("../../README.md")] #![doc = include_str!("../README.md")]
#![warn(missing_docs)] #![warn(missing_docs)]
// This mod MUST go first, so that the others see its macros. // This mod MUST go first, so that the others see its macros.