readme-updater

You can automatically update your README by analyzing project structure, build tools, and metadata to generate sections like Project Structure, Available Commands, and Configuration. The Skill preserves hand-written content while safely updating auto-generated sections.

Automated README generation will not overwrite hand-written documentation because the Skill intelligently preserves your content. It specifically marks auto-generated sections for safe updates, ensuring your manual edits remain intact during future project structure changes.

Sections that can be auto-generated from project metadata include Title, Description, Prerequisites, Installation, Usage, Project Structure, Commands, Configuration, Contributing, and License. The Skill analyzes build tools and project structure to populate these specific sections accurately.

To keep documentation consistent after changing build scripts, run the Skill to automatically update the README's Project Structure and Available Commands sections. This ensures new contributors have accurate information reflecting the latest project metadata and scripts.

This tool does not require any specific dependencies to analyze project configuration. It operates independently using internal scripts and references to evaluate your project structure, build tools, and metadata directly in the current directory.