-
Notifications
You must be signed in to change notification settings - Fork 165
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: | ||
- [`<FrameMetadata />`](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: | ||
- [`<Name />`](https://onchainkit.xyz/identitykit/introduction#name) | ||
- [`<Avatar />`](https://onchainkit.xyz/identitykit/introduction#avatar) | ||
|
||
<br /> | ||
|
||
## 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 [email protected] react@18 react-dom@18 | |
pnpm add @coinbase/onchainkit [email protected] 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,17 +121,13 @@ export default function HomePage() { | |
} | ||
``` | ||
|
||
<br /> | ||
|
||
## Community ☁️ 🌁 ☁️ | ||
|
||
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) | ||
|
||
<br /> | ||
|
||
## 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)) | ||
|
||
<br> | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details |