feat: renamed generateFrameNextMetadata to getFrameMetadata

.changeset/sweet-lobsters-shout.md

@@ -0,0 +1,5 @@
+---
+"@coinbase/onchainkit": patch
+---
+
+- **feat**: renamed `generateFrameNextMetadata` to `getFrameMetadata`

README.md

@@ -20,20 +20,20 @@ pnpm add @coinbase/onchainkit
 
 <br />
 
-## FrameKit utilities
+## FrameKit 🖼️
 
-### generateFrameNextMetadata
+### getFrameMetadata()
 
-Next App `page.ts`
+With Next.js App routing, use the `getFrameMetadata` inside your `page.ts` to get the metadata need it for your Frame.
 
 ```ts
 // Steps 1. import generateFrameNextMetadata from @coinbase/onchainkit
-import { generateFrameNextMetadata } from '@coinbase/onchainkit';
+import { getFrameMetadata } from '@coinbase/onchainkit';
 import type { Metadata } from 'next';
 import HomePage from './home';
 
 // Step 2. Use generateFrameNextMetadata to shape your Frame metadata
-const frameMetadata =  generateFrameNextMetadata({
+const frameMetadata = getFrameMetadata({
   buttons: ['boat'],
   image: 'https://build-onchain-apps.vercel.app/release/v-0-17.png',
   post_url: 'https://build-onchain-apps.vercel.app/api/frame',
@@ -51,3 +51,8 @@ export default function Page() {
   return <HomePage />;
 }
 ```
+
+`getFrameMetadata` params
+- `buttons`: A list of strings which are the label for the buttons in the frame (max 4 buttons). 
+- `image`: An image which must be smaller than 10MB and should have an aspect ratio of 1.91:1
+- `post_url`: A valid POST URL to send the Signature Packet to. 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/onchainkit",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "repository": "https://github.com/coinbase/onchainkit.git",
   "license": "MIT",
   "dependencies": {

src/core/generateFrameNextMetadata.ts → src/core/getFrameMetadata.ts

@@ -1,9 +1,11 @@
 /**
  * This function generates the metadata for a Farcaster Frame.
- * @param param0
- * @returns
+ * @param buttons: An array of button names.
+ * @param image: The image to use for the frame.
+ * @param post_url: The URL to post the frame to.
+ * @returns The metadata for the frame.
  */
-export const generateFrameNextMetadata = function ({
+export const getFrameMetadata = function ({
   buttons,
   image,
   post_url,

src/index.ts

@@ -2,4 +2,4 @@
 const version = '0.1.2';
 
 // TODO remove this line from here
-export { generateFrameNextMetadata } from './core/generateFrameNextMetadata';
+export { getFrameMetadata } from './core/getFrameMetadata';