From cd3c6996acf2db8eb02df0966fa6f76168ab1abf Mon Sep 17 00:00:00 2001
From: Steven Silvester <steven.silvester@ieee.org>
Date: Thu, 28 Sep 2023 09:41:30 -0500
Subject: [PATCH] GODRIVER-2955 [master] Add user-facing network compression
 documentation (#1404)

Co-authored-by: Preston Vasquez <prestonvasquez@icloud.com>
---
 README.md                      | 28 ++++++++++++++++++++++++++++
 mongo/options/clientoptions.go |  2 +-
 2 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b96dbd60d7..0c446d487b 100644
--- a/README.md
+++ b/README.md
@@ -147,6 +147,34 @@ if err == mongo.ErrNoDocuments {
 
 Additional examples and documentation can be found under the examples directory and [on the MongoDB Documentation website](https://www.mongodb.com/docs/drivers/go/current/).
 
+### Network Compression
+
+Network compression will reduce bandwidth requirements between MongoDB and the application. 
+
+The Go Driver supports the following compression algorithms:
+
+1. [Snappy](https://google.github.io/snappy/) (`snappy`): available in MongoDB 3.4 and later.
+2. [Zlib](https://zlib.net/) (`zlib`): available in MongoDB 3.6 and later.
+3. [Zstandard](https://github.com/facebook/zstd/) (`zstd`): available in MongoDB 4.2 and later.
+
+#### Specify Compression Algorithms
+
+Compression can be enabled using the `compressors` parameter on the connection string or by using [`ClientOptions.SetCompressors`](https://pkg.go.dev/go.mongodb.org/mongo-driver/mongo/options#ClientOptions.SetCompressors):
+
+```
+opts := options.Client().ApplyURI("mongodb://localhost:27017/?compressors=snappy,zlib,zstd")
+client, _ := mongo.Connect(context.TODO(), opts)
+```
+
+```
+opts := options.Client().SetCompressors([]string{"snappy", "zlib", "zstd"})
+client, _ := mongo.Connect(context.TODO(), opts)
+```
+
+If compressors are set, the Go Driver negotiates with the server to select the first common compressor. For server configuration and defaults, refer to [`networkMessageCompressors`](https://www.mongodb.com/docs/manual/reference/program/mongod/#std-option-mongod.--networkMessageCompressors).
+
+Messages compress when both parties enable network compression; otherwise, messages remain uncompressed
+
 -------------------------
 ## Feedback
 
diff --git a/mongo/options/clientoptions.go b/mongo/options/clientoptions.go
index f014da418b..fe9178cc49 100644
--- a/mongo/options/clientoptions.go
+++ b/mongo/options/clientoptions.go
@@ -573,7 +573,7 @@ func (c *ClientOptions) SetAuth(auth Credential) *ClientOptions {
 // 3. "zstd" - requires server version >= 4.2, and driver version >= 1.2.0 with cgo support enabled or driver
 // version >= 1.3.0 without cgo.
 //
-// If this option is specified, the driver will perform a negotiation with the server to determine a common list of of
+// If this option is specified, the driver will perform a negotiation with the server to determine a common list of
 // compressors and will use the first one in that list when performing operations. See
 // https://www.mongodb.com/docs/manual/reference/program/mongod/#cmdoption-mongod-networkmessagecompressors for more
 // information about configuring compression on the server and the server-side defaults.