You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rewrite packages/vechain-kit/README.md to lead with two AI prompts
("Start a new VeChain dApp" via create-vechain-dapp, "Add to existing
project") that tell the agent to read the relevant VeChain AI Skill
first. The manual install path is preserved below as a fallback.
Root README banner was 404 (i.ibb.co); replace with the same S3-hosted
shocase image already used by the npm README and the GitBook docs.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
VeChain Kit is a comprehensive SDK designed to make building frontend applications on VeChain fast and straightforward. It offers:
9
+
-**Seamless Wallet Integration:** VeWorld, Sync2, WalletConnect, and social logins (Google, Apple, GitHub, X/Twitter, Discord, TikTok, LINE, email, passkey via Privy).
10
+
-**Custom Connection UI:** A themeable connect modal owns the VeWorld and Sync2 flows end-to-end. WalletConnect's QR modal is preserved.
11
+
-**Developer-Friendly Hooks:** Easy-to-use React Hooks that let you read and write data on VeChainThor.
12
+
-**Pre-Built UI Components:** TransactionModal, ProfileModal, SendTokenModal — drop them in and go.
13
+
-**Token Operations:** Send, swap, check balances, manage VET domains.
10
14
11
-
- <b>Seamless Wallet Integration:</b> Support for VeWorld, Sync2, WalletConnect, and social logins (Google, Apple, GitHub, email, passkey via Privy).
12
-
- <b>Custom Connection UI:</b> A built-in, themeable connect modal owns the VeWorld and Sync2 flows end-to-end (no dapp-kit modal hand-off). WalletConnect's QR modal is preserved.
13
-
- <b>Developer-Friendly Hooks:</b> Easy-to-use React Hooks that let you read and write data on the VeChainThor blockchain.
14
-
- <b>Token Operations:</b> Send and swap tokens, check balances, manage VET domains, and more—all in one place.
15
-
- <b>Pre-Built UI Components:</b> Ready-to-use components (e.g., TransactionModal) to simplify wallet operations and enhance your users’ experience.
15
+
> **Note:** Currently supports React and Next.js only.
16
16
17
-
> **Note**: Currently supports React and Next.js only
17
+
## Start with AI (recommended)
18
18
19
-
### Resources
19
+
The fastest path is to hand a prompt to your coding agent (Claude Code, Cursor, or any agent). The prompts below tell the agent to read the relevant [VeChain AI Skill](https://github.com/vechain/vechain-ai-skills) first so it follows current conventions.
Scaffold a new VeChain dApp for me using create-vechain-dapp, with:
31
+
- VeChain Kit pre-wired (Privy social login: Google + email, plus VeWorld and WalletConnect)
32
+
- Chakra UI v3 (with next-themes) and dark mode by default — follow the next-chakra-v3 example in the vechain-kit repo for wiring the kit's `theme` prop via `useChakraContext().token.var(...)` so theme tokens stay reactive
33
+
- A landing page that shows the connected user's address, B3TR balance, and a "Send B3TR" button
34
+
- A GitHub Pages deploy workflow ready to use
35
+
36
+
Name the project "my-vechain-dapp". When done, run `yarn dev` and tell me the URL.
37
+
```
38
+
39
+
### Or: add VeChain Kit to an existing project
40
+
41
+
```text
42
+
Before doing anything, read this VeChain AI Skill so you follow current conventions:
I already have a Next.js app and I want to add VeChain Kit to it.
48
+
49
+
1. Install @vechain/vechain-kit and any required peer deps.
50
+
2. Find my root layout (app/layout.tsx for App Router or pages/_app.tsx for Pages Router) and wrap it with VeChainKitProvider.
51
+
3. Enable Privy social login (Google + email), VeWorld and WalletConnect.
52
+
4. Read Privy keys from NEXT_PUBLIC_PRIVY_* and the WalletConnect projectId from NEXT_PUBLIC_WC_PROJECT_ID.
53
+
5. Add a <WalletButton /> to my existing header.
54
+
6. Don't change my existing Chakra theme.
55
+
56
+
If you hit peer-dependency conflicts, stop and tell me before applying any fix.
57
+
```
23
58
24
-
### Quicks Start
59
+
### Why this works
25
60
26
-
#### Install dependencies
61
+
[VeChain AI Skills](https://github.com/vechain/vechain-ai-skills) give your coding agent up-to-date domain knowledge (wallet UX, smart contracts, VeBetterDAO, StarGate, and more). Install once:
27
62
28
-
Install the core package along with its peer dependencies:
63
+
```bash
64
+
npx skills add vechain/vechain-ai-skills
65
+
```
66
+
67
+
Or in Claude Code:
68
+
69
+
```text
70
+
/plugin marketplace add vechain/vechain-ai-skills
71
+
```
72
+
73
+
Browse all 11 skills and try each in context: <https://playground.vechainkit.vechain.org/ai-skills>.
// Optional: theme the brand accent (spinner, focus rings, "Waiting for signature…" headline)
90
137
theme={{ accent: '#3b82f6' }}
91
138
>
92
139
```
93
140
94
-
Available `method` values: `veworld`, `sync2`, `wallet-connect`, `google`, `apple`, `github`, `email`, `passkey`, `vechain` (cross-app), `ecosystem`, `more`, and the legacy `dappkit` (which still opens dapp-kit's native modal for backwards compatibility).
141
+
Available `method` values: `veworld`, `sync2`, `wallet-connect`, `google`, `apple`, `github`, `email`, `passkey`, `vechain` (cross-app), `ecosystem`, `more`, and the legacy `dappkit`.
95
142
96
-
For complete configuration options, check the [full documentation](https://docs.vechainkit.vechain.org/).
143
+
For full configuration options see the [documentation](https://docs.vechainkit.vechain.org/) or try every feature live in the [playground](https://playground.vechainkit.vechain.org/).
97
144
98
-
---
145
+
## Resources
99
146
100
-
# Troubleshooting
147
+
- [VeKit Playground](https://playground.vechainkit.vechain.org/) — interactive demos + code + AI prompts for every kit feature
0 commit comments