From 20f933607429144f5e487e3c4e1ff573e939bd89 Mon Sep 17 00:00:00 2001 From: DarkCat09 Date: Thu, 29 Aug 2024 21:02:53 +0400 Subject: [PATCH] docs: explain crate features --- src/lib.rs | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 1f9c6d8..4171cfe 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,14 @@ //! Gemini client and server implementaion in async Rust with Tokio and Rustls. -//! You probably need [`Client::builder()`] +//! You probably need [`Client::builder()`]. +//! +//! # Features +//! - `file-sscv`: known_hosts file parser and +//! helper functions for verifying a self-signed certificate. +//! - `dane`: alias to `hickory`. +//! - `hickory`: custom DNS client, also required for +//! a DANE-based verification. +//! - `hickory-dot`: enables DNS-over-TLS. +//! - `hickory-doh`: enables DNS-over-HTTPS. pub mod certs; pub mod client;