readme-updater

What problem does it solve?

This Skill eliminates the tedious manual work of keeping your project's README.md file current. It automatically detects code changes and suggests updates, ensuring your documentation is always accurate and saving you valuable time.

Core Features & Use Cases

• Automatic Updates: Intelligently detects changes in dependencies, features, API, setup instructions, and configuration files.
• Section-Specific Suggestions: Provides targeted updates for installation, features, environment variables, usage examples, and configuration sections.
• Use Case: When you add a new dependency (e.g., npm install stripe), the skill automatically suggests adding npm install stripe # For payment processing to your README's installation section and STRIPE_SECRET_KEY=your_key to environment variables.

Quick Start

The skill works automatically in the background.

Just make changes to your project, e.g., add a dependency:

npm install new-package

The skill will then suggest README updates based on this change.