From e2f5779c1275e7504668333318116746640855aa Mon Sep 17 00:00:00 2001 From: Leonardo Zizzamia Date: Mon, 4 Mar 2024 17:13:59 -0800 Subject: [PATCH] docs --- .changeset/spotty-melons-bathe.md | 6 ++++++ site/docs/pages/frame/introduction.mdx | 7 +------ site/docs/pages/identity/introduction.mdx | 19 ++++++++----------- src/version.ts | 2 +- 4 files changed, 16 insertions(+), 18 deletions(-) create mode 100644 .changeset/spotty-melons-bathe.md diff --git a/.changeset/spotty-melons-bathe.md b/.changeset/spotty-melons-bathe.md new file mode 100644 index 0000000000..cc1017c273 --- /dev/null +++ b/.changeset/spotty-melons-bathe.md @@ -0,0 +1,6 @@ +--- +'@coinbase/onchainkit': patch +--- + +- **feat**: added `FrameTransactionResponse` and `FrameTransactionEthSendParams` as initial version of Frame Transaction types. By @zizzamia #211 +- **docs**: polished introduction for Frame and Identity pages. By @zizzamia #211 diff --git a/site/docs/pages/frame/introduction.mdx b/site/docs/pages/frame/introduction.mdx index e0da644881..c679cc33b8 100644 --- a/site/docs/pages/frame/introduction.mdx +++ b/site/docs/pages/frame/introduction.mdx @@ -5,12 +5,7 @@ deescription: Introduction to Frame Kit # Introduction to Frame Kit -A Frame turns any cast into an interactive app. - -Creating a frame is simple: choose an image, add clickable buttons. -For more details, visit the [Farcaster Frames Official Documentation](https://docs.farcaster.xyz/learn/what-is-farcaster/frames). - -OnchainKit provides TypeScript utilities and React components. +OnchainKit provides TypeScript utilities and React components to help you build Frames. - Components: - [``](/frame/frame-metadata) diff --git a/site/docs/pages/identity/introduction.mdx b/site/docs/pages/identity/introduction.mdx index 53cca71630..ea30e8a5f5 100644 --- a/site/docs/pages/identity/introduction.mdx +++ b/site/docs/pages/identity/introduction.mdx @@ -5,10 +5,15 @@ deescription: Introduction to Identity Kit # Introduction to Identity Kit -Identity Kit is a collection of components and hooks that help you build user interfaces for Ethereum applications. -It provides a set of tools to resolve Ethereum addresses to ENS names, and more. +OnchainKit provides TypeScript utilities and React components to help you build applications that interact with onchain identity. -In order to use **Identity Kit** you must also install `graphql@14 graphql-request@6` in your app, alongside Onchainkit. +- Components: + - [``](/identity/avatar): A component to display an ENS avatar. + - [``](/identity/name): A component to display an ENS name. +- Utilities: + - [`getEASAttestations`](/identity/get-eas-attestations): A function to fetche EAS attestations. + +Required depedencies for using the Identity utilities and components are: :::code-group @@ -24,12 +29,4 @@ yarn add @coinbase/onchainkit react@18 react-dom@18 graphql@14 graphql-request@6 pnpm add @coinbase/onchainkit react@18 react-dom@18 graphql@14 graphql-request@6 ``` -To assist you in engaging with onchain Identity, here is the Identity Kit which includes: - ::: - -- Components: - - [``](/identity/avatar): A component to display an ENS avatar. - - [``](/identity/name): A component to display an ENS name. -- Utilities: - - [`getEASAttestations`](/identity/get-eas-attestations): A function to fetche EAS attestations. diff --git a/src/version.ts b/src/version.ts index 2352ca0c9f..9b90e3c8ce 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const version = '0.9.6'; +export const version = '0.9.7';