From bbc92d912f442a76f784902596db72d3e85a7956 Mon Sep 17 00:00:00 2001
From: Benjamin Kampmann <ben@gnunicorn.org>
Date: Thu, 17 Feb 2022 11:43:20 +0100
Subject: [PATCH] docs(ClientConfig): Add example for customn
 reqwest::ClientBuilder

---
 crates/matrix-sdk/src/config/client.rs | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/crates/matrix-sdk/src/config/client.rs b/crates/matrix-sdk/src/config/client.rs
index 45ee8efae..e6d4b6fcc 100644
--- a/crates/matrix-sdk/src/config/client.rs
+++ b/crates/matrix-sdk/src/config/client.rs
@@ -40,6 +40,27 @@ use crate::{config::RequestConfig, HttpSend, Result};
 ///     .disable_ssl_verification();
 /// # matrix_sdk::Result::<()>::Ok(())
 /// ```
+///
+/// # Example for using a custom client
+/// Note: setting a custom client will ignore `user_agent`, `proxy`, and
+/// `disable_ssl_verification` - you'd need to set these yourself if you
+/// want them.
+///
+/// ```
+/// use matrix_sdk::config::ClientConfig;
+/// use reqwest::ClientBuilder;
+/// use std::sync::Arc;
+///
+/// // setting up a custom builder
+/// let builder = ClientBuilder::new()
+///     .https_only(true)
+///     .no_proxy()
+///     .user_agent("MyApp/v3.0");
+///
+/// let client_config = ClientConfig::new()
+///     .client(Arc::new(builder.build()?));
+/// # matrix_sdk::Result::<()>::Ok(())
+/// ```
 #[derive(Default)]
 pub struct ClientConfig {
     #[cfg(not(target_arch = "wasm32"))]