From 4c1290fc2af11a766d823c82616338d0ae6a2a6d Mon Sep 17 00:00:00 2001 From: WindSoilder Date: Tue, 21 Jan 2020 06:42:26 +0800 Subject: [PATCH] Document socks proxy in lib. (#793) --- src/lib.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index e864b3a..23a813b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -141,6 +141,12 @@ //! i.e. `let proxy = reqwest::Proxy::http("https://secure.example")?;` //! or disabled by calling `ClientBuilder::no_proxy()`. //! +//! `socks` feature is required if you have configured socks proxy like this: +//! +//! ```bash +//! export https_proxy=socks5://127.0.0.1:1086 +//! ``` +//! //! ## TLS //! //! By default, a `Client` will make use of system-native transport layer