diff --git a/README.md b/README.md index c330bd6..a968713 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,13 @@ https://docs.rs/async-executor) Async executors. +This crate provides two reference executors that trade performance for +functionality. They should be considered reference executors that are "good +enough" for most use cases. For more specialized use cases, consider writing +your own executor on top of [`async-task`]. + +[`async-task`]: https://crates.io/crates/async-task + ## Examples ```rust diff --git a/src/lib.rs b/src/lib.rs index 79428cd..a30dc9c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,12 @@ //! Async executors. //! +//! This crate provides two reference executors that trade performance for +//! functionality. They should be considered reference executors that are "good +//! enough" for most use cases. For more specialized use cases, consider writing +//! your own executor on top of [`async-task`]. +//! +//! [`async-task`]: https://crates.io/crates/async-task +//! //! # Examples //! //! ```