readme-updater

Scans codebase changes and surgically updates existing frontend and backend READMEs.

Updated Jun 19, 2026
One-click install
npx skills add https://github.com/MatheusFelipeCorrea/Agrofarm --skill readme-updater-matheusfelipecorrea
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: readme-updater
Source: https://github.com/MatheusFelipeCorrea/Agrofarm/tree/main/.github/skills/readme-updater
Command: npx skills add https://github.com/MatheusFelipeCorrea/Agrofarm --skill readme-updater-matheusfelipecorrea

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Project READMEs quickly drift out of sync with the actual codebase as new files, routes, models, and dependencies are added. This Skill detects those discrepancies and updates existing READMEs without rewriting them, preserving the original format and style. ## Core Features & Use Cases - Change Detection: Scans source directories (controllers, services, hooks, pages, routes, Prisma schema, package.json) and compares them against what the README currently documents, classifying items as new, removed, or modified. - Surgical Updates: Applies only approved changes while preserving emojis, arrow notation, tables, ASCII trees, and the author's writing style; never rewrites from scratch. - Approval Workflow: Reports all detected changes in a structured table and waits for explicit user approval before modifying any file, with removals requiring separate confirmation. - Use Case: A team adds a new reports module (controller, service, routes, Prisma model). Run the skill to get a change report, approve it, and have both frontend and backend READMEs updated with the new entries in the correct sections. ## Quick Start Ask the assistant to scan the codebase and update the project READMEs to reflect the current state of the code.

Frequently Asked Questions about readme-updater

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

FAQPage Schema
How do I keep project READMEs in sync with my codebase?

Run the readme-updater skill to scan source directories and compare them against documented content. It reports new, removed, and modified files, methods, routes, and models, then applies only the changes you approve.

How to update a backend README from a Prisma schema?

The skill reads prisma/schema.prisma and the migrations folder to detect new or changed models, fields, and enums. It then updates the database section of the backend README using the existing arrow-notation format.

Does the readme updater rewrite my README from scratch?

No. It performs surgical updates only, preserving emojis, tables, ASCII folder trees, arrow notation, and the author's writing style. Removals require explicit approval and nothing is deleted silently.

What changes trigger a README update?

New or removed files, methods, routes, Prisma models or fields, dependencies, environment variables, and npm scripts all count. Internal logic changes, formatting, and comment edits do not warrant an update.

Can the skill handle non-Prisma ORMs or different folder layouts?

Yes. It supports equivalent ORM schema files such as Sequelize models, Mongoose schemas, TypeORM entities, or Django models, and it auto-detects README locations or accepts user-provided paths.