diff --git a/packages/frames-client/README.md b/packages/frames-client/README.md index ccca7e38..edeacbcd 100644 --- a/packages/frames-client/README.md +++ b/packages/frames-client/README.md @@ -1,4 +1,6 @@ -# frames-client +# Frames Client + +This repo is used by messaging apps to render Open Frames. ## Usage @@ -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`