doc: add feature flags section to README

Includes a note about how one runtime feature must be enabled.
jmagnuson · Nov 10, 2023 · 9b17424 · 9b17424
1 parent e36f793
commit 9b17424
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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