update-readme
Skill56 starsChanged 4 days agoMITView on GitHub
Reconcile README.md with the documentation site and SPEC.md with the shipped binary and code when those maintained surfaces change.
8 other projects use a version of this.
Adopted by
Most recently taken up by
- FradSer/skillstheir own version, first seen Oct 13, 2026
- vekzz-dev/opencode-skillstheir own version, first seen Oct 3, 2026
- emaraschio/cursor-commandstheir own version, first seen Aug 7, 2026
- iden0605/Claude-Skillstheir own version, first seen Jul 1, 2026
- Traroth/claude-dev-frameworktheir own version, first seen Apr 8, 2026
- oiiiwjh/skillstheir own version, first seen Mar 16, 2026
Other versions8 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 8
- emaraschio/cursor-commands★ 9same name
- FradSer/skills★ 4same name
- oiiiwjh/skills★ 4same name
- vekzz-dev/opencode-skills★ 4same name
- paulo-yamagishi/claude-code-setup★ 2same name
- andyshen1121/skills★ 1same name
- iden0605/Claude-Skills★ 1same name
- Traroth/claude-dev-framework★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository4 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- cafleet-model-list-refreshSkill
- clean-docsSkill
- skill-authorSkill
The file
Files
Update README and SPEC
Read the documentation-site concepts and navigation, the shipped CLI behavior and code, and the current maintained targets. Apply the task directly when it needs one session; use CAFleet for independent delegated review when the task calls for it. An assigned member performs its own scoped work within the existing team.
README structure
Retain the title/demo/pitch, Install, Documentation and License surfaces. Align the pitch with the site hero, installation with Quickstart and documentation links with navigation; the Specification link points at SPEC.md. Keep detailed CLI/architecture/development content in the documentation site.
SPEC maintenance
SPEC owns every contract and is the self-contained reimplementation specification. Reconcile it with the shipped binary and code: current CLI options/defaults, environment, schema, native input, finite receiving, authored errors, JSON order, text layouts, runtime, multiplexer and backend behavior. Preserve its section numbering (an empty numbered section is removed without renumbering the others) and required detail, update the affected contracts together, remove obsolete concepts completely and keep the description affirmative.
Retain exact current argv, SQL and error blocks, and reference bundled preset files by path. Verify § cross-references against the section headings. Report the focused validation performed and material limitations. Write all maintained artifacts in English.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

