readme-refresh

To automate a README audit and update, run the readme-refresh command-line tool in your project directory. It automatically compares project facts with existing README content to detect outdated, missing, or stale information and flags discrepancies for review.

The best way to generate a new README is using the tool's Bootstrap Mode. It automatically detects your project's tech stack, versions, and services, creating a new README file based on project facts and conventions.

Tech stack detection works by scanning your project directory to automatically identify frameworks, versions, and services used. This detected information is then compared against your current README to ensure documentation accurately reflects the project's dependencies.

No external dependencies are required to run the README audit. The skill operates independently using command-line interaction to trigger tasks, needing only access to your project directory to compare facts with the README.

A limitation of automating project documentation updates is that the tool requires command-line interaction to trigger tasks. It relies on detecting tech stack and dependencies from the project directory, meaning manual review is still needed for complex or non-standard configurations.