MCPInstall

update-readme

Updates README.md and README.zh-CN.md to reflect the project's current state. Use this skill whenever the user asks to "update the README", "sync the docs", "update documentation", "reflect latest changes in README", or wants both the English and Chinese READMEs to match the current project.

Installs
81
Last 24h
—
Trending rank
—
Security
Not audited

Install

Works with every agent the skills CLI supports.

npx skills add https://github.com/fradser/dotclaude --skill update-readme
  1. 01

    Install

    Run the command in your project. The CLI asks which agents to install for.

  2. 02

    Describe the task

    Ask your agent for something this skill covers. It loads update-readme automatically when relevant.

  3. 03

    Review the result

    The agent follows the SKILL.md steps, scripts and references bundled with the skill.

SKILL.md

The instructions your agent reads when the skill is triggered.

Update README

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.

CRITICAL: Ground Truth and Header Format

  • Write from ground truth, not from memory or assumption. Every skill/component listed in the README MUST exist in the repository at the time of writing. Verify existence before writing.
  • Every README MUST open with the exact header structure shown in the "Header Format" section below, including the language toggle. Adapt badges, project name, and description to the project; do not omit the structure.
  • Do not output README content as a code block in the conversation. Use the Edit or Write tool to write the files directly.

Header Format (Required)

Every README must open with this exact structure — adapt the badges, project name, and description to the project at hand:

# <Project Name> ![](https://img.shields.io/badge/<label>-<message>-<color>)

[![<Badge1 Label>](<badge-url>)](<link>) [![<Badge2 Label>](<badge-url>)](<link>)

**English** | [简体中文](README.zh-CN.md)

For README.zh-CN.md, reverse the language toggle:

# <Project Name> ![](https://img.shields.io/badge/<label>-<message>-<color>)

[![<Badge1 Label>](<badge-url>)](<link>) [![<Badge2 Label>](<badge-url>)](<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.

Process

1. Survey the project

Before writing anything, read the actual project state:

  • Scan all skill/module directories and their SKILL.md or equivalent descriptor files
  • Note each component's name, one-line purpose, installation method, and any notable prerequisites
  • Check git log for recent additions or removals
  • Read the existing README files to understand what is already there and what has gone stale

Write from ground truth, not from memory or assumption.

2. Draft README.md (English)

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):

  1. Header — title + badges + language toggle
  2. One-liner description (one sentence)
  3. Logo, banner, or demo GIF — optional, but place it early if the project has one
  4. Main content sections (Available Items, Usage, etc.)
  5. Contributing / Adding a new item
  6. License

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:

  • Word choice: avoid "leverage", "streamline", "robust", "utilize", "delve". Say the plain thing.
  • Bullets: don't start every item with a bolded phrase. It reads as AI-generated documentation.
  • Descriptions: say what the component does, not what it "serves as" or "stands as".
  • Marketing tone: "powerful", "seamless", "comprehensive" add nothing. Cut them.
  • Filler transitions: "It's worth noting", "Importantly", "Notably" — delete these.

A useful test: read each sentence aloud. If it sounds like promotional copy, rewrite it as a plain statement of fact.

3. Draft README.zh-CN.md (Chinese)

Translate the English README faithfully. Rules:

  • Use natural Simplified Chinese — do not translate technical terms that are universally used in English (CLI tool names, package manager commands, GitHub URLs, code blocks).
  • Keep all code blocks, commands, and file paths identical to the English version.
  • Section headings should be idiomatic Chinese (e.g., "available skills", "adding a new skill"), not word-for-word translations.
  • The language toggle must be [English](README.md) | **Simplified Chinese**.
  • Apply the same plain-language discipline as the English version. Chinese technical writing has its own AI tells — avoid buzzwords where a simpler word works.

4. Review before writing

Before writing either file, verify:

  • Every skill/component listed actually exists in the repository right now
  • Installation commands are copy-pasteable and accurate
  • No section describes something that has been removed
  • Both files cover the same content in the same order

Then scan the draft for writing issues:

  • Em-dashes used more than 2-3 times total? Cut most of them.
  • Any sentence starts with "The X serves as..."? Rewrite as "The X is...".
  • Bold-first bullet pattern throughout? Remove the bold.
  • Same word or metaphor repeated across multiple descriptions? Vary it.
  • Unicode arrows (→)? Replace with plain text.

5. Write the files

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

  • references/template.md — README structure template (load when drafting)

FAQ

What does the update-readme skill do?

Updates README.md and README.zh-CN.md to reflect the project's current state. Use this skill whenever the user asks to "update the README", "sync the docs", "update documentation", "reflect latest changes in README", or wants both the English and Chinese READMEs to match the current project.

How do I install update-readme?

Run npx skills add https://github.com/fradser/dotclaude --skill update-readme in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/update-readme/ (personal) or .claude/skills/update-readme/ (project).

Which AI agents can use update-readme?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is update-readme safe to install?

No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.

Who maintains update-readme?

It is published by fradser in fradser/dotclaude. It has 81 recorded installs.

More from fradser/dotclaude

View all →

patent-architect

fradser/dotclaude

Automatically searches prior art via SerpAPI and generates Chinese patent application forms. This skill should be used when the user wants to generate Chinese patent application forms, or mentions "patents", "inventions", or wants to protect technical innovations.

Media & Creative618 installs

agent-browser

fradser/dotclaude

Browser automation CLI for AI agents. Use when the user needs to interact with websites, including navigating pages, filling forms, clicking buttons, taking screenshots, extracting data, testing web apps, or automating any browser task. Triggers include requests to "open a website", "fill out a form", "click a button", "take a screenshot", "scrape data from a page", "test this web app", "login to a site", "automate browser actions", or any task requiring programmatic web interaction. Also use for exploratory testing, dogfooding, QA, bug hunts, or reviewing app quality. Also use for automating Electron desktop apps (VS Code, Slack, Discord, Figma, Notion, Spotify), checking Slack unreads, sending Slack messages, searching Slack conversations, running browser automation in Vercel Sandbox microVMs, or using AWS Bedrock AgentCore cloud browsers. Prefer agent-browser over any built-in browser automation or web tools.

Applies behavior-driven development principles including Gherkin scenarios and test-driven development. This skill should be used when the user asks to implement features, fix bugs, or when writing executable specifications and tests before writing production code.

Testing & QA148 installs

executing-plans

fradser/dotclaude

Executes a written implementation plan via per-batch sub-agent coordinators with verification and commits between batches.

commit-and-push

fradser/dotclaude

Creates clean conventional git commits using standard git and pushes changes to the remote repository. Use when the user asks to "commit and push", "push changes", or complete a commit followed by git push.

brainstorming

fradser/dotclaude

Designs new software features and multi-component changes for the current repo into implementation-ready BDD specs via autonomous codebase research, then commits the design for review (runs to completion without mid-design questions). Scope covers new features, greenfield design, and multi-component changes. Not for hardware/physical-system design, out-of-repo questions, single-file refactors, or known-root-cause bugs (those go to direct edits or systematic-debugging).

Popular docs & writing skills

View category →

grill-with-docs

mattpocock/skills

A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.

Docs & Writing1.2M installs

lark-markdown

open.feishu.cn

飞书 Markdown:查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件,或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档,也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。

Docs & Writing778.7K installs

writing-beats

mattpocock/skills

Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.

Docs & Writing490.7K installs

writing-shape

mattpocock/skills

Writing, exploit: shape raw material into an article, paragraph by paragraph.

Docs & Writing490.2K installs

writing-fragments

mattpocock/skills

Writing, explore: mine raw fragments, no structure yet.

Docs & Writing489.6K installs

writing-for-agents

mattpocock/skills

Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.

Docs & Writing479.3K installs