Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Zizzamia committed Mar 5, 2024
1 parent fd7cbec commit e2f5779
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 18 deletions.
6 changes: 6 additions & 0 deletions .changeset/spotty-melons-bathe.md
Original file line number Diff line number Diff line change
@@ -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
7 changes: 1 addition & 6 deletions site/docs/pages/frame/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
- [`<FrameMetadata />`](/frame/frame-metadata)
Expand Down
19 changes: 8 additions & 11 deletions site/docs/pages/identity/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
- [`<Avatar />`](/identity/avatar): A component to display an ENS avatar.
- [`<Name />`](/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

Expand All @@ -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:
- [`<Avatar />`](/identity/avatar): A component to display an ENS avatar.
- [`<Name />`](/identity/name): A component to display an ENS name.
- Utilities:
- [`getEASAttestations`](/identity/get-eas-attestations): A function to fetche EAS attestations.
2 changes: 1 addition & 1 deletion src/version.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const version = '0.9.6';
export const version = '0.9.7';

0 comments on commit e2f5779

Please sign in to comment.