chore: update README

[ymc9]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

README.md documentation updates: changed the npm badge image URL to reference zenstack/release-v2, replaced the V3 "in Beta" messaging with "V3 is released!" and updated related description and documentation link to point to the 2.x docs path.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md	Updated npm badge image URL from /zenstack to /zenstack/release-v2; replaced V3 status text from "V3 is in Beta now!" to "V3 is released!"; updated V3 description to reference the v3 repo; changed the "How it works" docs link to the 2.x docs path and adjusted formatting.

Sequence Diagram(s)

(omitted — changes are documentation-only and do not introduce new runtime control flow)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• chore: bump version, update README #2289: Modifies the README V3 section text and documentation link — closely related to the V3 messaging change.
• chore: show the npn download count of runtime package #2218: Updates the README npm badge URL — related to the badge image URL adjustment.
• merge dev to main (v2.21.0) #2290: Alters README V3 announcement and links — related to replacing "in Beta" with "is released" and updating URLs.

Pre-merge checks

❌ Failed checks (2 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'chore: update README' is vague and does not convey the specific nature of the changes, such as updating documentation links, badge URLs, or release status messaging.	Consider using a more descriptive title that highlights the main change, such as 'chore: update README for ZenStack v3 release' or 'chore: update README documentation links and badges'.
Description check	❓ Inconclusive	No pull request description was provided by the author, making it impossible to evaluate whether the description relates to the changeset.	Add a pull request description explaining the README updates, including the rationale for updating badges, documentation links, and release status messaging.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e6de940 and a6af7f5.

📒 Files selected for processing (1)

• README.md

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

10-10: Images should have alternate text (alt text)

(MD045, no-alt-text)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: build-test (20.x)
• GitHub Check: build-test (20.x)
• GitHub Check: dependency-review
• GitHub Check: build-test (20.x)

🔇 Additional comments (2)

README.md (2)

27-29: Heading and content are now consistent.

The section heading "## V3 is released!" now properly matches the content on line 29, which confirms v3 is "released". This resolves the previous inconsistency concern.

---

39-39: Documentation link update is appropriate.

The documentation URL has been correctly updated to reference the 2.x docs path, aligning with the v2 focus and badge URL change.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d48e71b and e6de940.

📒 Files selected for processing (1)

• README.md

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

10-10: Images should have alternate text (alt text)

(MD045, no-alt-text)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: build-test (20.x)
• GitHub Check: build-test (20.x)
• GitHub Check: build-test (20.x)
• GitHub Check: dependency-review

🔇 Additional comments (1)

README.md (1)

39-39: Documentation link update looks good.

The change to reference the 2.x docs path with the blockquote formatting is consistent with the PR objectives and properly directs users to the appropriate documentation version.