docs(readme): clarify install for v2 vs v3 alpha#5268
Conversation
Adds a small two-row table under "Getting Started" so readers can see at a glance which version they want to install: v2 (stable) for production use, or v3 (alpha) for the next-generation build. The rest of the README — sponsors image, badges, FAQ, etc. — is unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughREADME.md updated to replace a single external-link Getting Started instruction with a comprehensive two-version overview. A table now displays Wails v2 and v3 installation details, status, and documentation links, with a retained link to full installation instructions. Changes
Suggested labels
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/8 reviews remaining, refill in 2 minutes and 18 seconds.Comment |
There was a problem hiding this comment.
Pull request overview
Adds quick-install guidance in the root README so new users can choose between Wails v2 (stable) and v3 (alpha) at a glance.
Changes:
- Introduces a small table under “Getting Started” listing v2 vs v3 status, install command, and docs link
- Replaces the single installation-link sentence with the table + a follow-up link to full installation instructions
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Version | Status | Install | Docs | | ||
| |---|---|---|---| | ||
| | v2 | Stable | `go install github.com/wailsapp/wails/v2/cmd/wails@latest` | [wails.io](https://wails.io/) | | ||
| | v3 | Alpha | `go install github.com/wailsapp/wails/v3/cmd/wails3@latest` | [v3.wails.io](https://v3.wails.io/) | |
There was a problem hiding this comment.
The v3 install command points to github.com/wailsapp/wails/v3/cmd/wails3@latest, but this repository doesn’t contain a v3/cmd tree (currently v3/ only has scripts). As written, go install will fail for readers. Please update the v3 row to use the actual install path/version for the v3 CLI (as published), or replace the install cell with a link to the v3 installation docs instead of an unverified go install command.
| | v3 | Alpha | `go install github.com/wailsapp/wails/v3/cmd/wails3@latest` | [v3.wails.io](https://v3.wails.io/) | | |
| | v3 | Alpha | [See v3 installation docs](https://v3.wails.io/getting-started/installation/) | [v3.wails.io](https://v3.wails.io/) | |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Summary
Adds a small two-row table under "Getting Started" so readers can see at a glance which version of Wails they want — v2 stable, or v3 alpha — and copy the appropriate
go installline.Everything else (badges, sponsors image, JetBrains, FAQ, contributors, license, inspiration) is unchanged.
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit