Skip to content

docs: trim README badges to highest-signal set - #128

Merged
zeevdr merged 2 commits into
mainfrom
docs/readme-badges
Jun 10, 2026
Merged

docs: trim README badges to highest-signal set#128
zeevdr merged 2 commits into
mainfrom
docs/readme-badges

Conversation

@zeevdr

@zeevdr zeevdr commented Jun 10, 2026

Copy link
Copy Markdown
Member

Summary

  • Reduce header badges to the 5 highest-signal: CI, npm, License, Docs, Codespaces.
  • Drop Node-version, Downloads, repostatus "WIP", and codecov badges (Downloads is at zero pre-1.0; Alpha note already covers status).
  • Add a Docs badge linking to the GitHub Pages site, mirroring the Python SDK README.

Test plan

  • Visual check of remaining badge markup renders correctly

Drop Node-version, Downloads, repostatus, and codecov badges, and
add the GitHub Pages Docs badge (mirrors the Python SDK README).
Downloads is at zero pre-1.0 and the repostatus WIP badge undersells
the project; the Alpha note already covers status. Remaining badges
(CI, npm, License, Docs, Codespaces) cover maintenance, install,
licensing, docs, and a one-click try-it path.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Bundle size

Entry Size Budget Status
dist/index.js 101.5 kB 160000

Bring the badge count to 6 (within the agreed cap) by restoring
the codecov badge as a quality signal, and move the Codespaces
"try it now" badge to its own line so it stands out as a call
to action. Mirrors the same change in opendecree/decree.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Bundle size

Entry Size Budget Status
dist/index.js 101.5 kB 160000

@zeevdr
zeevdr merged commit fd6c232 into main Jun 10, 2026
3 checks passed
@zeevdr
zeevdr deleted the docs/readme-badges branch June 10, 2026 07:40
@github-project-automation github-project-automation Bot moved this from Todo to Done in OpenDecree Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant