docs: refine README header badges#13
Open
timzhong1024 wants to merge 5 commits intolarksuite:mainfrom
Open
Conversation
1fd10a1 to
f6df9f0
Compare
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 Agentsexplains the project flavor at a glancenpm downloadsgives a lightweight usage/activity signalLicensekeeps the open-source status visibleWhat changed
Awesome for Agentsnpm downloadsLicenseGitHub starsnpm versionGo VersionREADME.mdandREADME.zh.mdWhy remove the other badges
GitHub stars: useful as a social signal, but visually abrupt in this header and not essentialnpm version: adds package metadata, but not much value for first-time readersGo Version: emphasizes implementation details rather than user value, which is less helpful for a product-style CLI READMEResult
The final header focuses on three signals only:
This keeps the top of the README cleaner and easier to scan.