Skip to content

docs(readme): refresh badge row — add downloads, drop Conventional Commits#87

Merged
danielPoloWork merged 1 commit into
mainfrom
docs/readme-downloads-badge
Jul 5, 2026
Merged

docs(readme): refresh badge row — add downloads, drop Conventional Commits#87
danielPoloWork merged 1 commit into
mainfrom
docs/readme-downloads-badge

Conversation

@danielPoloWork

@danielPoloWork danielPoloWork commented Jul 5, 2026

Copy link
Copy Markdown
Owner

What

Refreshes the badge row in every README (EN source + ja + zh-Hans translations):

  • Adds a downloads badge after the CI badge:
    [![Downloads](https://img.shields.io/github/downloads/danielPoloWork/pgs-eamos/total.svg)](https://github.com/danielPoloWork/pgs-eamos/releases)
  • Removes the static Conventional Commits badge.

Why

  • The repo is public and v0.1.0 ships downloadable release assets (bundle .tar.gz/.zip, the setup.* installers, SHA256SUMS). The downloads badge surfaces adoption and links to the releases page.
  • The Conventional Commits badge was a static, unverified claim: the convention is documented in CONTRIBUTING.md and encoded as policy in git.yaml, but it is not CI-enforced (no commitlint job). It targeted a contributor concern in a row aimed at adopters, and trimming it keeps the distinctive grounding: labeled, never fabricated badge prominent.

Notes

  • Downloads badge uses an absolute releases URL, so the markup is byte-identical across all three files.
  • github/downloads counts release-asset downloads (not the auto-generated source zips), so it reads 0 until assets are actually downloaded — expected behaviour.
  • Build artifacts under build/eamos-target/ are left untouched (regenerated).

🤖 Generated with Claude Code

Add a shields.io github/downloads (total) badge to the badge block in
the EN source README and both derived translations (ja, zh-Hans), placed
right after the CI badge. The badge links to the releases page and counts
downloads of the v0.1.0 release assets (bundle + installers + SHA256SUMS).

Uses an absolute releases URL so it is identical across all three files.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@danielPoloWork danielPoloWork added the documentation Improvements or additions to documentation label Jul 5, 2026
@danielPoloWork danielPoloWork self-assigned this Jul 5, 2026
@danielPoloWork danielPoloWork added the documentation Improvements or additions to documentation label Jul 5, 2026
@danielPoloWork danielPoloWork marked this pull request as ready for review July 5, 2026 08:22
@danielPoloWork danielPoloWork merged commit 37a601e into main Jul 5, 2026
2 checks passed
@danielPoloWork danielPoloWork changed the title docs(readme): add release-downloads badge across all languages docs(readme): refresh badge row — add downloads, drop Conventional Commits Jul 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant