Skip to content

Commit

Permalink
Merge pull request #228 from xmtp/fabriguespe-patch-2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
rygine authored Jul 26, 2024
2 parents 9dcbd83 + 470b956 commit 3d1f7c0
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion packages/frames-client/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# frames-client
# Frames Client

This repo is used by messaging apps to render Open Frames.

## Usage

Expand All @@ -18,12 +20,15 @@ const imageUrl = framesClient.proxy.mediaUrl(
);

// Handle a click to button 2 from a conversation with topic "/xmtp/0/123" and participant addresses "abc" and "xyz"
const textInputValue = "Your value";
const payload = await signFrameAction({
frameUrl,
inputText: textInputValue || undefined,
buttonIndex: 2,
conversationTopic: "/xmtp/0/123",
participantAccountAddresses: ["abc", "xyz"],
address: "0x...",
state: frameMetadata?.frameInfo?.state, // Pulled from frame metadata
});

// If the button action type was `post`
Expand Down

0 comments on commit 3d1f7c0

Please sign in to comment.