aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2019-10-27 08:33:48 -0400
committerJesse Luehrs <doy@tozt.net>2019-10-27 08:33:48 -0400
commitc22aa86e33e3cdf987e6a1a4a15c729b0d3675dd (patch)
tree7e78f31aca1a150f7b2f26ab012ba620bbe4fcab
parentf900d0952cb94c88b33f85e9885ae00d6e56cdb5 (diff)
downloadttyrec-c22aa86e33e3cdf987e6a1a4a15c729b0d3675dd.tar.gz
ttyrec-c22aa86e33e3cdf987e6a1a4a15c729b0d3675dd.zip
update docs for feature0.1.0
-rw-r--r--README.md4
-rw-r--r--src/lib.rs4
2 files changed, 8 insertions, 0 deletions
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)]