TLS docs for tokio-postgres

sfackler · Apr 2, 2019 · 6c0ec6a · 6c0ec6a
1 parent 49c22a8
commit 6c0ec6a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/postgres/src/lib.rs b/postgres/src/lib.rs
@@ -50,7 +50,7 @@
 //!
 //! TLS support is implemented via external libraries. `Client::connect` and `Config::connect` take a TLS implementation
 //! as an argument. The `NoTls` type in this crate can be used when TLS is not required. Otherwise, the
-//! `tokio-postgres-openssl` and `tokio-postgres-native-tls` crates provide implementations backed by the `postgres` and
+//! `tokio-postgres-openssl` and `tokio-postgres-native-tls` crates provide implementations backed by the `openssl` and
 //! `native-tls` crates, respectively.
 #![warn(clippy::all, rust_2018_idioms, missing_docs)]
 

diff --git a/tokio-postgres/src/lib.rs b/tokio-postgres/src/lib.rs
@@ -101,6 +101,13 @@
 //! The client works with arbitrary `AsyncRead + AsyncWrite` streams. Convenience APIs are provided to handle the
 //! connection process, but these are gated by the `runtime` Cargo feature, which is enabled by default. If disabled,
 //! all dependence on the tokio runtime is removed.
+//!
+//! # SSL/TLS support
+//!
+//! TLS support is implemented via external libraries. `Client::connect` and `Config::connect` take a TLS implementation
+//! as an argument. The `NoTls` type in this crate can be used when TLS is not required. Otherwise, the
+//! `tokio-postgres-openssl` and `tokio-postgres-native-tls` crates provide implementations backed by the `openssl` and
+//! `native-tls` crates, respectively.
 #![doc(html_root_url = "https://docs.rs/tokio-postgres/0.4.0-rc.1")]
 #![warn(rust_2018_idioms, clippy::all, missing_docs)]