docs: rebuild README for conversion + refresh all translations (v0.6.2)#28
Merged
Merged
Conversation
Cut the README from 380 → ~248 lines using the patterns of top OSS projects (uv, Bun, Zod, Hono): a tight hero (tagline + badges, incl. a live monthly npm-downloads badge), the before/after catch screenshots up top, the two-stage value prop (verify claims → make the agent prove it), one-command install, and everything optional folded into <details> or linked to /docs. Regenerated all 8 translations (zh-CN, es, pt-BR, fr, de, ja, ru, ar) to match, with corrected relative paths and language switchers; Arabic wrapped RTL. Docs/metadata only — no behavior change. 141 tests pass. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Tightens every README to high-conversion form using the patterns of top OSS projects (uv, Bun, Zod, Hono).
English README: 380 → 248 lines
npm/dm, the honest scoped-package choice;npm/dtsilently downgrades to 18-month for scopes).npx @veltiq/groundtruth setup).<details>or linked to/docs.All 8 translations regenerated
zh-CN, es, pt-BR, fr, de, ja, ru, ar — matched to the new structure, correct relative paths + language switchers, Arabic wrapped RTL. Verified: downloads badge +
setuppresent in all 8, commands untranslated, all link targets resolve.Docs/metadata only — no behavior change. 141 tests pass, lint + typecheck clean. Ships as 0.6.2 so the slim README reaches the npm page.
🤖 Generated with Claude Code