Skip to content

docs: refine README header badges#13

Open
timzhong1024 wants to merge 5 commits intolarksuite:mainfrom
timzhong1024:codex/readme-downloads-badge
Open

docs: refine README header badges#13
timzhong1024 wants to merge 5 commits intolarksuite:mainfrom
timzhong1024:codex/readme-downloads-badge

Conversation

@timzhong1024
Copy link
Copy Markdown
Contributor

@timzhong1024 timzhong1024 commented Mar 28, 2026

Summary

Refine the README header badges in both English and Chinese READMEs.

Why

The original header felt visually sparse, but adding too many badges quickly made it look noisy and overly engineering-heavy.

This PR keeps the header intentionally restrained and product-facing:

  • Awesome for Agents explains the project flavor at a glance
  • npm downloads gives a lightweight usage/activity signal
  • License keeps the open-source status visible

What changed

  • Added Awesome for Agents
  • Added npm downloads
  • Kept License
  • Removed GitHub stars
  • Removed npm version
  • Removed Go Version
  • Updated both README.md and README.zh.md

Why remove the other badges

  • GitHub stars: useful as a social signal, but visually abrupt in this header and not essential
  • npm version: adds package metadata, but not much value for first-time readers
  • Go Version: emphasizes implementation details rather than user value, which is less helpful for a product-style CLI README

Result

The final header focuses on three signals only:

  • project positioning
  • lightweight activity signal
  • license

This keeps the top of the README cleaner and easier to scan.

@timzhong1024 timzhong1024 changed the title docs: add npm downloads badge to readmes docs: refine README header badges Mar 28, 2026
@timzhong1024 timzhong1024 force-pushed the codex/readme-downloads-badge branch from 1fd10a1 to f6df9f0 Compare March 28, 2026 16:03
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

2 participants