From 9b17424df590345667f0de4f6f7da52e92ee7b14 Mon Sep 17 00:00:00 2001 From: Jon Magnuson Date: Fri, 10 Nov 2023 16:42:34 -0600 Subject: [PATCH] doc: add feature flags section to README Includes a note about how one runtime feature must be enabled. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index f602210..9695ea6 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,13 @@ Add linemux to your `Cargo.toml` with: linemux = "0.3" ``` +### Feature flags + +Note that building with `default-features: false` must also be coupled with activating a desired +runtime (currently just `tokio`, but eventually others will be supported). + +- `tokio`: Use the tokio runtime (default). + ## Example ```rust,no_run