Skip to content

docs: add package/CI badges and clarify bash requirement in README#5

Merged
zywkloo merged 2 commits into
mainfrom
codex/update-documentation-and-add-badges-shm90c
May 27, 2026
Merged

docs: add package/CI badges and clarify bash requirement in README#5
zywkloo merged 2 commits into
mainfrom
codex/update-documentation-and-add-badges-shm90c

Conversation

@zywkloo

@zywkloo zywkloo commented May 27, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Make package availability and CI status more visible from the repository landing page and set clearer expectations for platform support.

Description

  • Added repository badges for npm, PyPI, CI, GitHub releases, and license to the top of README.md.
  • Clarified the bash row in the Requirements table to state macOS / Linux only (Windows is currently not supported).
  • Kept existing install instructions and project overview intact while improving discoverability of package and CI metadata.

Testing

  • This is a documentation-only change and no automated tests were run as part of this PR.

Codex Task

@zywkloo zywkloo merged commit 72b4a68 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