Skip to content

docs(readme): add status badges to both READMEs - #1

Merged
BlackHole1 merged 1 commit into
mainfrom
docs/readme-badges
Jun 25, 2026
Merged

BlackHole1 merged 1 commit into
mainfrom
docs/readme-badges

Conversation

@BlackHole1

Copy link
Copy Markdown
Member

Add a badge row under the language switcher in the English and Simplified Chinese READMEs so the repository's health and metadata are visible at a glance: CI status, latest release, Homebrew tap, platform, language, and license.

CI, release, and license badges are served by shields.io dynamic endpoints that track the repo automatically. The Homebrew badge is static because the custom tap (oomol-lab/tap) is not covered by the shields Homebrew endpoint.

Add a badge row under the language switcher in the English and
Simplified Chinese READMEs so the repository's health and metadata
are visible at a glance: CI status, latest release, Homebrew tap,
platform, language, and license.

CI, release, and license badges are served by shields.io dynamic
endpoints that track the repo automatically. The Homebrew badge is
static because the custom tap (`oomol-lab/tap`) is not covered by the
shields Homebrew endpoint.

Signed-off-by: Kevin Cui <bh@bugs.cc>
@BlackHole1
BlackHole1 merged commit 8cee152 into main Jun 25, 2026
2 of 3 checks passed
@BlackHole1
BlackHole1 deleted the docs/readme-badges branch June 25, 2026 09:57
@coderabbitai

coderabbitai Bot commented Jun 25, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b52b79e6-685a-457c-bfe0-ef69153d5be6

📥 Commits

Reviewing files that changed from the base of the PR and between 9253003 and d5a02b1.

📒 Files selected for processing (2)
  • README.md
  • README.zh-CN.md

Summary by CodeRabbit

  • Documentation
    • Added prominent status and metadata badges near the top of the English and Chinese README files.
    • Included badges for CI status, latest release, Homebrew availability, macOS support, language, and license.

Walkthrough

README.md and README.zh-CN.md now include a set of status and metadata badges near the top of each document. The added badges cover CI workflow status, latest release, Homebrew tap availability, macOS platform, Objective-C language, and license.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title uses the required format <type>(<scope>): <subject> with 'docs' as type and 'readme' as scope, clearly summarizing the main change of adding status badges to READMEs.
Description check ✅ Passed The description is directly related to the changeset, explaining the purpose of adding status badges to both README files and detailing their sources and functionality.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/readme-badges

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant