From 2993a3a04f3a0cbec877153180466de1f6f9ce5b Mon Sep 17 00:00:00 2001
From: Kezhu Wang <kezhuw@gmail.com>
Date: Thu, 10 Oct 2024 08:41:37 +0800
Subject: [PATCH] Doc async runtime support

---
 Cargo.toml | 3 +++
 src/lib.rs | 8 ++++++++
 2 files changed, 11 insertions(+)

diff --git a/Cargo.toml b/Cargo.toml
index 5bde3d6..78c2b4a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -20,6 +20,9 @@ tls = ["rustls", "rustls-pemfile", "webpki-roots"]
 sasl = ["sasl-gssapi", "sasl-digest-md5"]
 sasl-digest-md5 = ["rsasl/unstable_custom_mechanism", "md5", "linkme", "hex"]
 sasl-gssapi = ["rsasl/gssapi"]
+tokio = ["asyncs/tokio"]
+smol = ["asyncs/smol"]
+async-global-executor = ["asyncs/async-global-executor"]
 
 [dependencies]
 bytes = "1.1.0"
diff --git a/src/lib.rs b/src/lib.rs
index 58bec80..39f3d01 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -18,6 +18,14 @@
 //! * `sasl`: Toggle SASL support.
 //! * `sasl-gssapi`: Toggle only GSSAPI SASL support. This relies on binding package `libgssapi-sys`.
 //! * `sasl-digest-md5`: Toggle only DIGEST-MD5 SASL support.
+//!
+//! ## Async runtime support
+//! This library uses [asyncs](https://docs.rs/asyncs) and [spawns](https://docs.rs/spawns) to
+//! spawn asynchronous tasks. It exposes runtime feature flags for handy. Please refer their docs
+//! for references.
+//! * `tokio`: Toggle support for [tokio](https://docs.rs/tokio).
+//! * `smol`: Toggle support for [smol](https://docs.rs/smol) builtin global executor.
+//! * `async-global-executor`: Toggle support for [async-global-executor](https://docs.rs/async-global-executor).
 
 mod acl;
 mod chroot;