agentleFS
Sign inStart free
emaraschioemaraschio/cursor-commands/.cursor/skill-contracts/update-readme/SKILL.md

update-readme

Skill9 starsChanged 3 months agoMITView on GitHub

Update project README for current state

8 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Update the project README.md to reflect the current repository state: features, setup, configuration tables, and links.

    line 10
  2. Distinctive:

    Read existing README.md and table of contents structure.

    line 14
  3. Distinctive:

    Run git log --oneline -15 and inspect recent structural changes.

    line 15
  4. Distinctive:

    Update sections that drifted.

    line 16

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Update README

Overview

Update the project README.md to reflect the current repository state: features, setup, configuration tables, and links. Do not confuse with memory bank updates.

Steps

  1. Read existing README.md and table of contents structure.
  2. Run git log --oneline -15 and inspect recent structural changes.
  3. Update sections that drifted; preserve required sections (Installation, Usage, Configuration, Troubleshooting).
  4. Validate internal links; fix broken paths.
  5. Summarize changes for the user; do not commit unless asked.

Checklist

  • Required sections preserved
  • Command/skill index links accurate if present
  • No secrets in examples

Guardrails

  • Preserve required README sections (Installation, Usage, Configuration, Troubleshooting).
  • Validate internal links and fix broken paths; do not commit unless asked.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.

Check your setup, free