README Updater

This skill helps maintain a consistent and up-to-date README.md file for your repository. It automates the process of extracting information from the project's codebase to ensure documentation is always in sync with implementation.

Features

1. Project Overview Synchronization: Updates the project description and features list based on the latest implementation.
2. Installation & Setup Tracking: Automatically detects project type (Node.js, Python, Rust, etc.) and updates setup/installation commands.
3. Usage Examples Generator: Scrapes code examples from test suites or examples/ directory and integrates them into the README.
4. Version and Changelog Linking: Keeps the current version and links to the CHANGELOG.md updated.
5. Dependency Visualization: Optionally generates or updates a list of main dependencies or a simple architecture overview.

Workflow

Step 1: Analyze the Workspace

Before updating, the agent must gather context about the project's current state.