Skip to content

Commit

Permalink
Merge pull request #2 from node-real/docs
Browse files Browse the repository at this point in the history
docs: Update readme
  • Loading branch information
wenty22 authored Oct 26, 2023
2 parents e6941a8 + 11d1f15 commit e541f58
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 19 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
# walletkit
# WalletKit

WalletKit is a React component library for easily connecting a wallet to your dApp.

## Main Features

- 💡 Typescript — Get types straight out of the box.
- 🌱 Ecosystem Standards — Built on top of [wagmi](https://wagmi.sh) and [viem](https://viem.sh)
- 🎨 Customization — Easily customizing wallets and themes

## Documentation

For full documentation, visit [here](https://node-real.github.io/walletkit/website/dist/#/index).

## Examples

The following examples are provided in the [examples](./examples/) folder of this repo.

- [vite](https://github.com/node-real/walletkit/tree/main/examples/vite)

## Installation

```bash
npm i @totejs/walletkit wagmi viem

```

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Loading

0 comments on commit e541f58

Please sign in to comment.