diff --git a/README.md b/README.md index 05df7d1b97..65ba07c9f2 100644 --- a/README.md +++ b/README.md @@ -51,16 +51,27 @@ For documentation and guides, visit [onchainkit.xyz](https://onchainkit.xyz/). ## Features - [Farcaster Kit](https://onchainkit.xyz/farcasterkit/introduction) - - Utilitis: + - Utilities: - [`getFarcasterUserAddress`](https://onchainkit.xyz/farcasterkit/get-farcaster-user-address) - [Frame Kit](https://onchainkit.xyz/framekit/introduction) + + - Components: + - [``](https://onchainkit.xyz/framekit/introduction#framemetadata-) + - Utilities: + - [`getFrameHtmlResponse`](https://onchainkit.xyz/framekit/introduction#getframehtmlresponseframemetadata) + - [`getFrameMessage`](https://onchainkit.xyz/framekit/introduction#getframemessageframerequest) + - [`getFrameMetadata`](https://onchainkit.xyz/framekit/introduction#getframemetadataframemetadata) + - [Identity Kit](https://onchainkit.xyz/identitykit/introduction) + - Components: + - [``](https://onchainkit.xyz/identitykit/introduction#name) + - [``](https://onchainkit.xyz/identitykit/introduction#avatar)
## Overview -Add OnchainKit to your project, install the required packages. +To integrate OnchainKit into your project, begin by installing the necessary packages. ```bash # Use Yarn @@ -73,9 +84,11 @@ npm install @coinbase/onchainkit viem@2.x react@18 react-dom@18 pnpm add @coinbase/onchainkit viem@2.x react@18 react-dom@18 ``` -And use any of the Components or Utilities like `FrameMetadata`. +Then, feel free to utilize any of the components or utilities, such as `FrameMetadata`. ```tsx +import { FrameMetadata } from '@coinbase/onchainkit'; + export default function HomePage() { return ( ... @@ -108,8 +121,6 @@ export default function HomePage() { } ``` -
- ## Community ☁️ 🌁 ☁️ Check out the following places for more OnchainKit-related content: @@ -117,8 +128,6 @@ Check out the following places for more OnchainKit-related content: - Follow @zizzamia ([X](https://twitter.com/zizzamia), [Farcaster](https://warpcast.com/zizzamia)) for project updates - Join the discussions on our [OnchainKit warpcast channel](https://warpcast.com/~/channel/onchainkit) -
- ## Authors - [@zizzamia](https://github.com/zizzamia.png) ([X](https://twitter.com/Zizzamia)) @@ -128,8 +137,6 @@ Check out the following places for more OnchainKit-related content: - [@cnasc](https://github.com/cnasc.png) ([warpcast](https://warpcast.com/cnasc)) - [@wespickett](https://github.com/wespickett.png) ([X](https://twitter.com/wespickett)) -
- ## License This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details