Merge pull request #182 from xmtp/dj/frames-readme

Update README for new frames client spec
xmtp · Feb 6, 2024 · 54a7e9e · 54a7e9e
2 parents c019140 + ab0dd5d
commit 54a7e9e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/.changeset/many-mugs-suffer.md b/.changeset/many-mugs-suffer.md
@@ -0,0 +1,5 @@
+---
+"@xmtp/frames-client": patch
+---
+
+updated readme
diff --git a/packages/frames-client/README.md b/packages/frames-client/README.md
@@ -11,7 +11,12 @@ const frameUrl = "https://www.myframe.xyz";
 // Read data from a frame
 const frameMetadata = await readMetadata(frameUrl);
 
-// Handle a click to button 2 from a conversation with topic "/xmtp/0/123" on messageId "45678"
-const payload = await signFrameAction(frameUrl, 2, "/xmtp/0/123", "45678");
+// Handle a click to button 2 from a conversation with topic "/xmtp/0/123" and participant addresses "abc" and "xyz"
+const payload = await signFrameAction({
+  frameUrl,
+  buttonIndex: 2,
+  conversationTopic: "/xmtp/0/123",
+  participantAccountAddresses: ["abc", "xyz"],
+});
 const updatedFrameMetadata = await postToFrame(frameUrl, payload);
 ```