Skip to content

Commit

Permalink
Merge pull request #61 from reown-com/fix/install-packages
Browse files Browse the repository at this point in the history
fix: Add @reown/appkit package to installation guide.
  • Loading branch information
rohit-710 authored Sep 20, 2024
2 parents d9f2a57 + 77ccbbe commit 9a1d525
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 29 deletions.
8 changes: 4 additions & 4 deletions docs/appkit/javascript/core/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,28 +33,28 @@ We recommend using [Vite](https://vitejs.dev/guide/#scaffolding-your-first-vite-
<PlatformTabItem value="wagmi">

```bash npm2yarn
npm install @reown/appkit-adapter-wagmi wagmi viem
npm install @reown/appkit @reown/appkit-adapter-wagmi wagmi viem
```

</PlatformTabItem>
<PlatformTabItem value="ethers5">

```bash npm2yarn
npm install @reown/appkit-adapter-ethers5 ethers@5.7.2
npm install @reown/appkit @reown/appkit-adapter-ethers5 ethers@5.7.2
```

</PlatformTabItem>
<PlatformTabItem value="ethers">

```bash npm2yarn
npm install @reown/appkit-adapter-ethers ethers
npm install @reown/appkit @reown/appkit-adapter-ethers ethers
```

</PlatformTabItem>
<PlatformTabItem value="solana">

```bash npm2yarn
npm install @reown/appkit-adapter-solana
npm install @reown/appkit @reown/appkit-adapter-solana
```

</PlatformTabItem>
Expand Down
22 changes: 9 additions & 13 deletions docs/appkit/migration/from-rainbowkit-next.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Follow the steps below to migrate from the default RainbowKit project using Next
+ Run this command to install AppKit and uninstall RainbowKit.

```bash
pnpm install @web3modal/wagmi && pnpm uninstall @rainbow-me/rainbowkit
pnpm install @reown/appkit @reown/appkit-adapter-wagmi && pnpm uninstall @rainbow-me/rainbowkit
```

### Step 3. Change the index.tsx
Expand Down Expand Up @@ -48,7 +48,7 @@ AppKit's web components are global HTML elements that don't require importing.
- import { getDefaultConfig } from '@rainbow-me/rainbowkit';
/* highlight-delete-end */
/* highlight-add-start */
+ import { defaultWagmiConfig } from "@web3modal/wagmi/react/config";
+ import { WagmiAdapter } from '@reown/appkit-adapter-wagmi'
/* highlight-add-end */
```

Expand Down Expand Up @@ -84,18 +84,14 @@ export const metadata = {
icons: ["https://example.com/favicon.png"]
};

// Create wagmiConfig
export const config = defaultWagmiConfig({
chains, // chains are the same
projectId, // Use the new project ID
metadata,
auth: {
email: true,
socials: ["github", "google", "x", "discord", "apple"],
showWallets: true, // default to true
},
export const networks = [mainnet, arbitrum]

// Create wagmiAdapter
onst wagmiAdapter = new WagmiAdapter({
ssr: true,
});
networks,
projectId
})
/* highlight-add-end */
```

Expand Down
8 changes: 4 additions & 4 deletions docs/appkit/next/core/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,28 +34,28 @@ These steps are specific to [Next.js](https://nextjs.org/) app router. For other
<PlatformTabItem value="wagmi">

```bash npm2yarn
npm install @reown/appkit-adapter-wagmi wagmi viem @tanstack/react-query
npm install @reown/appkit @reown/appkit-adapter-wagmi wagmi viem @tanstack/react-query
```

</PlatformTabItem>
<PlatformTabItem value="ethers5">

```bash npm2yarn
npm install @reown/appkit-adapter-ethers5 ethers@5.7.2
npm install @reown/appkit @reown/appkit-adapter-ethers5 ethers@5.7.2
```

</PlatformTabItem>
<PlatformTabItem value="ethers">

```bash npm2yarn
npm install @reown/appkit-adapter-ethers ethers
npm install @reown/appkit @reown/appkit-adapter-ethers ethers
```

</PlatformTabItem>
<PlatformTabItem value="solana">

```bash npm2yarn
npm install @reown/appkit-adapter-solana
npm install @reown/appkit @reown/appkit-adapter-solana
```

</PlatformTabItem>
Expand Down
8 changes: 4 additions & 4 deletions docs/appkit/react/core/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,28 +31,28 @@ Choose one of these ethereum libraries or solana to get started.
<PlatformTabItem value="wagmi">

```bash npm2yarn
npm install @reown/appkit-adapter-wagmi wagmi viem @tanstack/react-query
npm install @reown/appkit @reown/appkit-adapter-wagmi wagmi viem @tanstack/react-query
```

</PlatformTabItem>
<PlatformTabItem value="ethers5">

```bash npm2yarn
npm install @reown/appkit-adapter-ethers5 ethers@5.7.2
npm install @reown/appkit @reown/appkit-adapter-ethers5 ethers@5.7.2
```

</PlatformTabItem>
<PlatformTabItem value="ethers">

```bash npm2yarn
npm install @reown/appkit-adapter-ethers ethers
npm install @reown/appkit @reown/appkit-adapter-ethers ethers
```

</PlatformTabItem>
<PlatformTabItem value="solana">

```bash npm2yarn
npm install @reown/appkit-adapter-solana
npm install @reown/appkit @reown/appkit-adapter-solana
```

</PlatformTabItem>
Expand Down
8 changes: 4 additions & 4 deletions docs/appkit/vue/core/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,28 +30,28 @@ AppKit has support for [Wagmi](https://wagmi.sh/), [Ethers](https://docs.ethers.
<PlatformTabItem value="wagmi">

```bash npm2yarn
npm install @reown/appkit-adapter-wagmi wagmi viem
npm install @reown/appkit @reown/appkit-adapter-wagmi wagmi viem
```

</PlatformTabItem>
<PlatformTabItem value="ethers5">

```bash npm2yarn
npm install @reown/appkit-adapter-ethers5 ethers@5.7.2
npm install @reown/appkit @reown/appkit-adapter-ethers5 ethers@5.7.2
```

</PlatformTabItem>
<PlatformTabItem value="ethers">

```bash npm2yarn
npm install @reown/appkit-adapter-ethers ethers
npm install @reown/appkit @reown/appkit-adapter-ethers ethers
```

</PlatformTabItem>
<PlatformTabItem value="solana">

```bash npm2yarn
npm install @reown/appkit-adapter-solana
npm install @reown/appkit @reown/appkit-adapter-solana
```

</PlatformTabItem>
Expand Down

0 comments on commit 9a1d525

Please sign in to comment.