update-readme

update-readme is a skill for Claude Code from FradSer/dotclaude. It costs 65 tokens per session (1,422 once invoked), scanned A, original, MIT.

A documentation task that updates a project's English and Simplified Chinese README files to match what actually exists in the repository. It verifies listed components before writing and keeps both files consistent.

In plain words
What is it for?
Use it when code or project components change and the README needs to reflect the current state in both languages.
Why use it?
It removes stale or inaccurate setup and feature information from the main project documentation.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Part of the utils plugin — 2 skills shipped together

Good fit Use it when code or project components change and the README needs to reflect the current state in both languages.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/fradser/dotclaude/update-readme
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add FradSer/dotclaude --skill update-readme
Clone the repo
git clone --depth 1 https://github.com/FradSer/dotclaude

Made for: Claude Code.

Or install utils, the plugin that ships this one along with the rest of its 2 skills.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for update-readme

README.md
[![agentmods](https://agentmods.dev/badge/skills/fradser/dotclaude/update-readme/github.svg)](https://agentmods.dev/skills/fradser/dotclaude/update-readme)
Your own site
<a href="https://agentmods.dev/skills/fradser/dotclaude/update-readme"><img src="https://agentmods.dev/badge/skills/fradser/dotclaude/update-readme/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for update-readme

Your own site · 80×15
<a href="https://agentmods.dev/skills/fradser/dotclaude/update-readme"><img src="https://agentmods.dev/badge/skills/fradser/dotclaude/update-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 65 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,422 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00065 $0.01422
Opus 5.5 $0.00026 $0.00569
Sonnet 5.5 $0.00013 $0.00284
Haiku 4.5 $0.00006 $0.00142

Measured 22d ago against content hash feb34b02c7a6, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

update-readme scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 22d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

utils/skills/update-readme/SKILL.md · 118 lines

How it starts

The opening of the file, as written. The whole thing — 118 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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

Read the full file on GitHub · 118 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 22d ago First seen · 118 lines · 65 tokens per session scan A feb34b02c7a6

Subscribe to this mod's changes

update-readme is a skill published in the GitHub repository FradSer/dotclaude (593 stars, last pushed 7d ago), licensed MIT. It adds 65 tokens to every session and 1,422 once invoked, about $0.0003 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-24.

Related

Other skills, from other repositories

azure-ai-translation-text-py

Azure AI Text Translation SDK for real-time text translation, transliteration, language detection, and dictionary lookup. Use for translating text content in applications. Triggers: "text translation", "translator", "translate text", "transliterate", "TextTranslationClient".

microsoft/skills · 60 tokens

chinese-documentation

A Chinese technical-documentation style guide covering spacing, punctuation, numbers, terminology, and links when Chinese and English appear together.

jnMetaCode/superpowers-zh · 62 tokens

harden

Improve interface resilience through better error handling, i18n support, text overflow handling, and edge case management. Makes interfaces robust and production-ready. Use when the user asks to harden, make production-ready, handle edge cases, add error states, or fix overflow and i18n issues.

fengshao1227/ccg-workflow · 62 tokens

seedance-vocab-ja

This skill should be used when the user asks for Japanese Seedance 2.0 prompt wording, Japanese cinematic vocabulary, or translation of camera, lighting, action, VFX, audio, and production terms into Japanese.

Emily2040/seedance-2.0 · 50 tokens

asc-subscription-localization

Bulk-localize subscription, subscription-group, and in-app purchase display names across App Store locales using asc, including API 4.4.1 version-scoped v2 resources. Use when filling or updating subscription/IAP names and descriptions without App Store Connect UI work.

rorkai/app-store-connect-cli-skills · 60 tokens

adaptation

This skill should be used when the user asks to "make an audiobook", "narration script", "narrator", "ACX", "Findaway", "pronunciation guide", "how long is the audiobook", "adapt to a screenplay", "Fountain", "screenplay", "picture book", "spreads", "illustration notes", "art notes", "comic script", "comics script"…

danjdewhurst/story-skills · 182 tokens