docs: make README English-first with badges, add zh-TW translation - #8
Merged
Merged
Conversation
Rewrite README.md in English as the primary language and move the existing Traditional Chinese content to README.zh-TW.md, with a language switcher at the top of both files. Add CI, release, pkg.go.dev, Go Report Card, Go version, license, and platform badges, plus a License section. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VUL5iqayzR4XCN9NGwQLYR
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
2 participants
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
The README was Traditional Chinese only, which limits reach for a tool whose audience is Claude Code users worldwide. This makes English the primary language and keeps the Chinese version as a first-class translation.
Changes
README.md— full English rewrite of the existing content (install, subcommands, verbose flags, compression logic, config, architecture, uninstall, contributing). Nothing dropped; only a## Licensesection added.README.zh-TW.md— the original Traditional Chinese content preserved verbatim, plus the same badges and License section.**English** | [繁體中文](README.zh-TW.md)and its mirror).Badges
CI status, latest release, pkg.go.dev, Go Report Card, Go version (read from
go.mod), Apache-2.0 license, and supported platforms.Docs-only change — no code touched.
🤖 Generated with Claude Code
https://claude.ai/code/session_01VUL5iqayzR4XCN9NGwQLYR