From 930d904205691ff06104fcc3ac108177077def35 Mon Sep 17 00:00:00 2001
From: ofekshenawa <104765379+ofekshenawa@users.noreply.github.com>
Date: Wed, 13 Nov 2024 13:20:59 +0200
Subject: [PATCH] Add guidance on unstable RESP3 support for RediSearch
 commands to README (#3177)

* Add UnstableResp3 to docs

* Add RawVal and RawResult to wordlist

* Explain more about SetVal

* Add UnstableResp to wordlist
---
 .github/wordlist.txt |  3 +++
 README.md            | 15 +++++++++++++++
 2 files changed, 18 insertions(+)

diff --git a/.github/wordlist.txt b/.github/wordlist.txt
index c200c60b..1fc34f73 100644
--- a/.github/wordlist.txt
+++ b/.github/wordlist.txt
@@ -54,6 +54,7 @@ stunnel
 SynDump
 TCP
 TLS
+UnstableResp
 uri
 URI
 url
@@ -62,3 +63,5 @@ RedisStack
 RedisGears
 RedisTimeseries
 RediSearch
+RawResult
+RawVal
\ No newline at end of file
diff --git a/README.md b/README.md
index 37714a97..e7136765 100644
--- a/README.md
+++ b/README.md
@@ -186,6 +186,21 @@ rdb := redis.NewClient(&redis.Options{
 #### Unstable RESP3 Structures for RediSearch Commands
 When integrating Redis with application functionalities using RESP3, it's important to note that some response structures aren't final yet. This is especially true for more complex structures like search and query results. We recommend using RESP2 when using the search and query capabilities, but we plan to stabilize the RESP3-based API-s in the coming versions. You can find more guidance in the upcoming release notes.
 
+To enable unstable RESP3, set the option in your client configuration:
+
+```go
+redis.NewClient(&redis.Options{
+			UnstableResp3: true,
+		})
+```
+**Note:** When UnstableResp3 mode is enabled, it's necessary to use RawResult() and RawVal() to retrieve a raw data.
+          Since, raw response is the only option for unstable search commands Val() and Result() calls wouldn't have any affect on them:
+
+```go
+res1, err := client.FTSearchWithArgs(ctx, "txt", "foo bar", &redis.FTSearchOptions{}).RawResult()
+val1 := client.FTSearchWithArgs(ctx, "txt", "foo bar", &redis.FTSearchOptions{}).RawVal()
+```
+
 ## Contributing
 
 Please see [out contributing guidelines](CONTRIBUTING.md) to help us improve this library!