docs: explain crate features

This commit is contained in:
DarkCat09 2024-08-29 21:02:53 +04:00
parent a7fca98939
commit 20f9336074
Signed by: DarkCat09
GPG key ID: BD3CE9B65916CD82

View file

@ -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;