From c22aa86e33e3cdf987e6a1a4a15c729b0d3675dd Mon Sep 17 00:00:00 2001 From: Jesse Luehrs Date: Sun, 27 Oct 2019 08:33:48 -0400 Subject: update docs for feature --- README.md | 4 ++++ src/lib.rs | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/README.md b/README.md index fdfef97..c9c104c 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,7 @@ This crate contains helpers for reading and writing `Parser` and `Creator` can be used to read and write files manually, and `Reader` and `Writer` are helpers to provide a nicer API for asynchronous applications using `tokio`. + +If you are not using `tokio`, the `tokio` dependencies can be removed by +building with `default_features = false` (by default, the `"async"` +feature is enabled which provides `tokio` support). diff --git a/src/lib.rs b/src/lib.rs index c08be3a..b0d6296 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -4,6 +4,10 @@ //! `Parser` and `Creator` can be used to read and write files manually, and //! `Reader` and `Writer` are helpers to provide a nicer API for asynchronous //! applications using `tokio`. +//! +//! If you are not using `tokio`, the `tokio` dependencies can be removed by +//! building with `default_features = false` (by default, the `"async"` +//! feature is enabled which provides `tokio` support). // XXX this is broken with ale // #![warn(clippy::cargo)] -- cgit v1.2.3