sync-readme

Instructions for keeping an English README and a Chinese README matched in content and structure. They cover comparing files, translating prose, preserving code and links, and checking language links.

In plain words
What is it for?
Use them to compare both README files, decide which is newer, translate changed sections, and preserve formatting and technical terms.
Why use it?
They reduce missing or inconsistent documentation when one language version changes.

Skill for Claude CodeCodex

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.

agentmods
npx agentmods add skills/lbb00/ai-rules-sync/sync-readme
Any agent
npx skills add lbb00/ai-rules-sync --skill sync-readme
Clone the repo
git clone --depth 1 https://github.com/lbb00/ai-rules-sync

Made for: Claude Code, Codex.

Per session 20 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 540 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00020 $0.00540
Opus 5 $0.00010 $0.00270
Sonnet 5 $0.00004 $0.00108
Haiku 4.5 $0.00002 $0.00054

Measured 3d ago against content hash d31bb94cf8b1, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

sync-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 3d 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.

.claude/skills/sync-readme/SKILL.md · 79 lines

How it starts

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

Sync README

Purpose

Keep the English (README.md) and Chinese (README_ZH.md) documentation in sync. When one is updated, this skill helps translate and synchronize changes to the other.

Instructions

  1. Compare Both Files

    • Read README.md and README_ZH.md
    • Identify sections that differ
    • Note new sections in either file
  2. Determine Sync Direction

    • If English was updated more recently: translate EN → ZH
    • If Chinese was updated more recently: translate ZH → EN
    • If unclear, ask user which is the source of truth
  3. Translate Content

    • Preserve all code blocks unchanged
    • Translate prose sections accurately
    • Keep technical terms consistent:
      • "rules" → "规则"
      • "commands" → "命令"
      • "skills" → "技能"
      • "agents" → "代理"
      • "instructions" → "指令"
      • "adapter" → "适配器"
      • "symbolic link" → "软链接"
  4. Preserve Structure

    • Keep same heading hierarchy
    • Maintain table formats
    • Preserve all links and badges
    • Keep code examples identical
  5. Update Language Links

    • Ensure language toggle links are present
    • English: [English](./README.md) | [中文](./README_ZH.md)
    • Chinese: [English](./README.md) | [中文](./README_ZH.md)
  6. Verify Completeness

    • All sections present in both files
    • All features documented in both
    • Examples work in both versions

Translation Guidelines

Section Headers

English Chinese
Install 安装
Commands 命令
Architecture 架构
Tab Completion Tab 补全
Legacy compatibility Legacy 兼容说明
Supported Sync Types 支持的同步类型

Common Phrases

English Chinese
Default mapping 默认映射
Source directory 源目录
Target directory 目标目录
Run this command 运行此命令
This command will 该命令会

Output

After running this skill:

  • Both README files contain identical information
  • All features documented in both languages
  • Formatting consistent across both files

Read the full file on GitHub · 79 lines

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. 3d ago First seen · 79 lines · 20 tokens per session scan A d31bb94cf8b1

Subscribe to this mod's changes

sync-readme is a skill published in the GitHub repository lbb00/ai-rules-sync (37 stars, last pushed 13d ago), licensed Unlicense. It adds 20 tokens to every session and 540 once invoked, about $0.0001 per session on Opus 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-08-30.

Related

Other skills, from other repositories

authoring-skills-and-rules

Author Skills (SKILL.md) and rules/instructions across Claude Code, Cursor, OpenCode, Codex, and GitHub Copilot. Covers frontmatter, file layout, activation model, cross-platform mirroring, and the universal craft: progressive disclosure, trigger-rich descriptions (context pointers), leading words, token budget…

afaraha8403/balakit · 132 tokens

chinese-documentation

中文文档排版参考——中英文空格、全半角标点、术语保留、链接格式、中文文案排版指北约定。仅在用户显式 /chinese-documentation 时调用,不要根据上下文自动触发。.

jnMetaCode/superpowers-zh · 62 tokens

review-rewrite-content

Use when Indonesian, English, or code-mixed notes, experiences, scripts, or drafts need coordinated story structure, hook improvement, anti-AI-slop editing, Jabodetabek register adaptation, or an end-to-end content review without factual drift.

konten-studio/jekardah-writer · 57 tokens

lingui-best-practices

Implement internationalization with Lingui in React and JavaScript applications. Use when adding i18n, translating UI, working with Trans/useLingui/Plural, extracting messages, compiling catalogs, or when the user mentions Lingui, internationalization, i18n, translations, locales, message extraction, ICU…

lingui/skills · 78 tokens

enhanced-message-context

Add translator comments to Lingui messages so translations are accurate. Use when adding or modifying translatable messages, when strings are short or ambiguous ("Back", "Delete", "Post"), when placeholders are unclear ({count}, {name}), when deciding between comment and context, or when auditing extracted .po…

lingui/skills · 70 tokens

migrate-i18next-to-lingui

Migrate i18next/react-i18next projects to Lingui. Use when the user wants to replace i18next, react-i18next, useTranslation, i18n.t(), Trans i18nKey, or i18next JSON catalogs with Lingui equivalents. Covers package installation, config setup, code transformation patterns, plural migration, namespace handling, and…

lingui/skills · 86 tokens