update-readme

Validate and regenerate bilingual README files to reflect current skill sets.

4|Updated Mar 8, 2026
One-click install
npx skills add https://github.com/FradSer/skills --skill update-readme-fradser
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-readme
Source: https://github.com/FradSer/skills/tree/main/skills/update-readme
Command: npx skills add https://github.com/FradSer/skills --skill update-readme-fradser

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps English README.md and README.zh-CN.md in sync with the actual project state, ensuring both languages reflect the current skill set and usage rules.

Core Features & Use Cases

  • Detects additions or removals of skills and regenerates the bilingual README files.
  • Ensures header format, badges, and installation guidance remain consistent across languages.
  • Useful when onboarding new skills or updating existing ones in bilingual projects.

Quick Start

Regenerate both READMEs after updating the skills/ directory by running the update-readme skill.

Frequently Asked Questions about update-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep bilingual README files in sync with my project's current skill set?▼

To sync bilingual README files with your project's current skill set, you can validate and regenerate both English and Chinese READMEs to reflect evolving skill inventories, including additions and removals.

How do I update English and Chinese markdown documentation after adding new skills?▼

Updating English and Chinese markdown documentation after adding new skills requires aligning both README files by regenerating them to reflect the current project state while preserving existing installation guidance and links.

What is the best way to maintain header format and parity across bilingual project READMEs?▼

Maintaining header format and parity across bilingual project READMEs involves specifying required frontmatter and header structure, ensuring both language files remain consistent during documentation regeneration.

Can I preserve existing installation guidance and links when regenerating bilingual README files?▼

Yes, you can preserve existing installation guidance and links when regenerating bilingual README files, as the documentation alignment process safeguards these elements while updating the skill inventory.

Does syncing README documentation work for projects with evolving skill inventories and removals?▼

Syncing README documentation works effectively for bilingual projects with evolving skill inventories, detecting both additions and removals to keep the English and Chinese documentation accurate and consistent.

When should I regenerate bilingual markdown files to align repository documentation?▼

You should regenerate bilingual markdown files to align repository documentation whenever you update the skills directory, ensuring both language versions reflect the current skill set and required frontmatter.