Skip to content

docs: add npm/PyPI/CI/Homebrew badges and clarify Windows support#4

Merged
zywkloo merged 1 commit into
mainfrom
codex/update-documentation-and-add-badges
May 27, 2026
Merged

docs: add npm/PyPI/CI/Homebrew badges and clarify Windows support#4
zywkloo merged 1 commit into
mainfrom
codex/update-documentation-and-add-badges

Conversation

@zywkloo

@zywkloo zywkloo commented May 27, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Make the README surface up-to-date package and CI status so users can quickly see the latest releases and build health.
  • Prevent confusion about supported platforms by explicitly calling out that Windows is not supported for the CLI (bash-based) workflows.

Description

  • Added dynamic Shields badges at the top of README.md for npm version, PyPI version, CI status, and Homebrew tap formula version.
  • Updated the Requirements table to state that bash is supported on "macOS / Linux only (Windows is currently not supported)".
  • The Homebrew badge uses the Shields homebrew formula endpoint and links to the tap repository.

Testing

  • Ran the project smoke suite with chmod +x tests/smoke.sh && tests/smoke.sh in a Linux environment and it PASSED (verification summary: 1 passed, 0 failed).

Codex Task

@zywkloo zywkloo merged commit e071ca9 into main May 27, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant