Skip to content

Commit

Permalink
add README.md for package (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
technophile-04 authored Apr 30, 2024
1 parent 904d4a2 commit 310022c
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .changeset/slimy-pants-draw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"burner-connector": patch
---

add README.md
49 changes: 49 additions & 0 deletions packages/burner-connector/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# 🔥 Burner Connector

## Quickstart

1. Install the dependencies:

```bash
npm install burner-connector

or

yarn add burner-connector

or

pnpm add burner-connector
```

2. Using wagmi `burner` connector :

```ts
import { burner } from "burner-connector";
export const config = createConfig({
chains: [mainnet, base],
connectors: [burner()],
transports: {
[mainnet.id]: http(),
[base.id]: http(),
},
});
```

3. Integrate with rainbowkit:

```ts
import { rainbowkitBurnerWallet } from "burner-connector";

const wallets = [metaMaskWallet, rainbowkitBurnerWallet];

const wagmiConfig = createConfig({
chains: [mainnet, base],
connectors: wagmiConnectors,
ssr: true,
transports: {
[mainnet.id]: http(),
[base.id]: http(),
},
});
```

0 comments on commit 310022c

Please sign in to comment.