Skip to content

Commit

Permalink
docs: updated readme (#81)
Browse files Browse the repository at this point in the history
  • Loading branch information
Zizzamia authored Feb 4, 2024
1 parent 7410f87 commit a2f862e
Showing 1 changed file with 43 additions and 6 deletions.
49 changes: 43 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,38 @@
<img src='./docs/logo-v-0-4.png' width='800' alt='OnchainKit'>

# [OnchainKit](https://github.com/coinbase/onchainkit/)

> OnchainKit is a collection of tools to build world-class onchain apps with CSS, React, and Typescript.
<p align="center">
<a href="https://github.com/coinbase/onchainkit">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./docs/logo-v-0-4.png">
<img alt="OnchainKit logo vibes" src="./docs/logo-v-0-4.png" width="auto">
</picture>
</a>
</p>

# OnchainKit

<p align="left">
OnchainKit is a collection of tools to build world-class onchain apps with CSS, React, and Typescript.
<p>

<p align="left">
<a href="https://www.npmjs.com/package/@coinbase/onchainkit">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/@coinbase/onchainkit?colorA=21262d&colorB=21262d&style=flat">
<img src="https://img.shields.io/npm/v/viem?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Version">
</picture>
</a>
<a href="https://github.com/coinbase/onchainkit/blob/main/LICENSE.md">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/l/@coinbase/onchainkit?colorA=21262d&colorB=21262d&style=flat">
<img src="https://img.shields.io/npm/l/@coinbase/onchainkit?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="MIT License">
</picture>
</a>
<a href="https://www.npmjs.com/package/@coinbase/onchainkit">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/dm/@coinbase/onchainkit?colorA=21262d&colorB=21262d&style=flat">
<img src="https://img.shields.io/npm/dm/@coinbase/onchainkit?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Downloads per month">
</picture>
</a>
</p>

## Getting Started

Expand All @@ -21,10 +51,17 @@ npm install @coinbase/onchainkit
pnpm add @coinbase/onchainkit
```

<br />

OnchainKit is divided into various theme utilities and components that are available for your use:

- [Frame Kit 🖼️](https://github.com/coinbase/onchainkit?tab=readme-ov-file#frame-kit-)
- [Identity Kit 👨‍🚀](https://github.com/coinbase/onchainkit?tab=readme-ov-file#identity-kit-)

<br />
<br />

## FrameKit 🖼️
## Frame Kit 🖼️

A Frame transforms any cast into an interactive app.

Expand Down

0 comments on commit a2f862e

Please sign in to comment.