Updates README.md and README.zh-CN.md to match the project's current state by surveying files, git history, and using a standardized template with badges and bilingual toggles.
From utilsnpx claudepluginhub fradser/dotclaude --plugin utilsupdate-readme//SKILLEvaluates code generation models on HumanEval, MBPP, MultiPL-E, and 15+ benchmarks using BigCode harness, computing pass@k metrics via code execution.
/SKILLRuns `yarn extract-errors` on React project to detect new error messages needing codes, reports them, and verifies existing codes are up to date.
/SKILLApplies systematic debugging strategies to track down bugs, performance issues, and unexpected behavior using checklists, scientific method, and testing techniques.
/SKILLManages major dependency upgrades via compatibility analysis, staged rollouts with npm/yarn, and testing for frameworks like React.
/SKILLEvaluates LLMs on 60+ benchmarks (MMLU, HumanEval, GSM8K) using lm-eval harness. Provides CLI commands for HuggingFace/vLLM models, task lists, and evaluation checklists.
/SKILLGuides implementation of defense-in-depth security architectures, compliance (SOC2, ISO27001, GDPR, HIPAA), threat modeling, risk assessments, SecOps, incident response, and SDLC security integration.
Keep README.md (English, primary) and README.zh-CN.md (Simplified Chinese, secondary) in sync with the project's actual current state. Both files must be accurate, complete, and consistent with each other.
Every README must open with this exact structure — adapt the badges, project name, and description to the project at hand:
# <Project Name> 
[](<link>) [](<link>)
**English** | [简体中文](README.zh-CN.md)
For README.zh-CN.md, reverse the language toggle:
# <Project Name> 
[](<link>) [](<link>)
[English](README.md) | **简体中文**
Choose badges that reflect what is genuinely true about the project. Common types: CI status, license, language/runtime version, package registry version, code coverage. Use shields.io static badges when there is no live endpoint. Prefer reference-style Markdown links for badge rows with more than two badges — it keeps the source readable. Broken or always-failing badges are worse than no badges; only include ones that are maintained.
Before writing anything, read the actual project state:
Write from ground truth, not from memory or assumption.
Use references/template.md as the structural starting point. Adapt section names to the project's domain — the template shows the skeleton, not the words.
Section order (omit what doesn't apply, don't add sections just to fill space):
For READMEs over ~300 lines, add a Table of Contents after the one-liner.
The README is a directory, not a tutorial. Keep each component description to one or two sentences. Installation commands must be copy-pasteable — exact commands, no ambiguity. Always use fenced code blocks with a language tag (```bash, ```json).
Write with a human voice. README prose is some of the most AI-trope-prone writing that exists — it tends to accumulate "robust", bold-first bullet points, and "serves as" constructions without anyone noticing. Specific things to watch for:
A useful test: read each sentence aloud. If it sounds like promotional copy, rewrite it as a plain statement of fact.
Translate the English README faithfully. Rules:
[English](README.md) | **简体中文**.Before writing either file, verify:
Then scan the draft for writing issues:
Write README.md first, then README.zh-CN.md. Use the Edit or Write tool — do not output the content as a code block in the conversation.
After writing, briefly confirm what changed (e.g., "Added update-readme skill, removed stale apple-events prerequisite note").
references/template.md — README structure template (load when drafting)