diff --git a/.changeset/shiny-eggs-grin.md b/.changeset/shiny-eggs-grin.md deleted file mode 100644 index 69c5dbcc..00000000 --- a/.changeset/shiny-eggs-grin.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@totejs/walletkit': patch ---- - -Test github action diff --git a/.changeset/smooth-drinks-walk.md b/.changeset/smooth-drinks-walk.md deleted file mode 100644 index 1036148d..00000000 --- a/.changeset/smooth-drinks-walk.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@totejs/walletkit': patch ---- - -Support more wallets. diff --git a/packages/walletkit/CHANGELOG.md b/packages/walletkit/CHANGELOG.md index 71ce3d3f..3ffac76b 100644 --- a/packages/walletkit/CHANGELOG.md +++ b/packages/walletkit/CHANGELOG.md @@ -1,5 +1,12 @@ # @totejs/walletkit +## 1.0.5 + +### Patch Changes + +- 3b612c2: Test github action +- 0284dee: Support more wallets. + ## 1.0.4 ### Patch Changes diff --git a/packages/walletkit/README.md b/packages/walletkit/README.md new file mode 100644 index 00000000..fd2986f6 --- /dev/null +++ b/packages/walletkit/README.md @@ -0,0 +1,78 @@ +# WalletKit + +WalletKit is a React component library for easily connecting a wallet to your dApp. + +## 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. + +- [nextjs](https://github.com/node-real/walletkit/tree/main/examples/nextjs) +- [vite](https://github.com/node-real/walletkit/tree/main/examples/vite) + +## Installation + +```bash +npm i @totejs/walletkit wagmi viem + +``` + +## Usage + +```tsx +import '@totejs/walletkit/styles.css'; +import { WagmiConfig, createConfig } from 'wagmi'; +import { chains } from './chains'; +import { + WalletKitButton, + WalletKitProvider, + getDefaultConfig, + WalletKitOptions, + SwitchNetworkModal, +} from '@totejs/walletkit'; +import { metaMask, trustWallet, walletConnect } from '@totejs/walletkit/wallets'; + +const config = createConfig( + getDefaultConfig({ + autoConnect: true, + appName: 'WalletKit', + + // WalletConnect 2.0 requires a projectId which you can create quickly + // and easily for free over at WalletConnect Cloud https://cloud.walletconnect.com/sign-in + walletConnectProjectId: 'xxx', + + chains, + connectors: [trustWallet(), metaMask(), walletConnect()], + }), +); + +const options: WalletKitOptions = { + initialChainId: 56, +}; + +export default function App() { + return ( + + + + + {/* + 👇 Here's the SwitchNetworkModal + If the user switches to a network that is not supported by our dapp, + this modal will be displayed to remind the user to switch to our supported networks. + */} + + + + ); +} +``` diff --git a/packages/walletkit/package.json b/packages/walletkit/package.json index 16cfde4c..c068e450 100644 --- a/packages/walletkit/package.json +++ b/packages/walletkit/package.json @@ -1,6 +1,6 @@ { "name": "@totejs/walletkit", - "version": "1.0.4", + "version": "1.0.5", "author": "node-real", "private": false, "description": "WalletKit is a React component library for easily connecting a wallet to your dApp.",