Document required tokio features for example

Fixes #1714
tokio-rs · Jan 20, 2023 · 2dddf7c · 2dddf7c
1 parent b07918b
commit 2dddf7c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/axum/CHANGELOG.md b/axum/CHANGELOG.md
@@ -9,9 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - **added:** Implement `IntoResponse` for `&'static [u8; N]` and `[u8; N]` ([#1690])
 - **fixed:** Make `Path` support types uses `serde::Deserializer::deserialize_any` ([#1693])
+- **fixed:** Document required tokio features to run "Hello, World!" example ([#1715])
 
 [#1690]: https://github.com/tokio-rs/axum/pull/1690
 [#1693]: https://github.com/tokio-rs/axum/pull/1693
+[#1715]: https://github.com/tokio-rs/axum/pull/1715
 
 # 0.6.2 (9. January, 2023)
 

diff --git a/axum/src/lib.rs b/axum/src/lib.rs
@@ -61,6 +61,9 @@
 //! }
 //! ```
 //!
+//! Note using `#[tokio::main]` requires you enable tokio's `macros` and `rt-multi-thread` features
+//! or just `full` to enable all features (`cargo add tokio --features macros,rt-multi-thread`).
+//!
 //! # Routing
 //!
 //! [`Router`] is used to setup which paths goes to which services: