What I do

Analyze project structure: Examine directory layout, source files, and configuration
Detect project type: Identify language/framework from package.json, Cargo.toml, go.mod, requirements.txt, etc.
Extract metadata: Get project name, description, scripts, dependencies from config files
Check existing README: Review current README.md content if it exists
Detect codebase changes: Analyze recent git changes to understand what's new or modified
Generate README: Create comprehensive README with appropriate sections
Update existing README: Edit current README.md to reflect codebase changes
Show preview: Display generated content for confirmation before writing

When to use me

Use this when you want to:

Create a new README.md for a fresh project
Update an existing README to reflect current codebase state
Update README based on recent changes in the repository (new features, changed dependencies, etc.)
Add missing sections like installation, usage, or API docs
Generate documentation based on project structure