Merge pull request #249 from xmtp/ar/broadcast-read-me-updates

chore: Update ReadMe
xmtp · Jun 18, 2024 · 5ddd500 · 5ddd500
2 parents b794667 + 02325ac
commit 5ddd500
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/.changeset/angry-sheep-guess.md b/.changeset/angry-sheep-guess.md
@@ -0,0 +1,5 @@
+---
+"@xmtp/broadcast-sdk": patch
+---
+
+Updated Readme
diff --git a/packages/broadcast/README.md b/packages/broadcast/README.md
@@ -1,5 +1,12 @@
 # Broadcast SDK
 
+## Introduction
+
+User the Broadcast SDK to broadcast to thousands of your subscribers
+The Broadcast SDK attempts to take away the need to handle Rate Limiting logic while also allowing integrators information about the broadcast and current statuses
+
+Recommended to use with GRPC client and client caching like the Redis Client
+
 ## Installation
 ```
 yarn add @xmtp/broadcast-sdk
@@ -9,8 +16,15 @@ yarn add @xmtp/broadcast-sdk
 ```ts
 import { Client } from "@xmtp/xmtp-js"
 import { BroadcastClient } from "@xmtp/broadcast-sdk"
-// It is highly recommended to use the GRPC client
-const client = await Client.create(wallet)
+
+// It is highly recommended to use the GRPC client and base a base persistence
+import { GrpcApiClient } from "@xmtp/grpc-api-client";
+import { RedisPersistence } from "@xmtp/redis-persistence";
+
+const client = await Client.create(wallet, {
+  apiClientFactory: GrpcApiClient.fromOptions,
+  basePersistence: new RedisPersistence(redis, "xmtp:"),
+})
 
 const broadcastClient = new BroadcastClient({
   client,