Update README
Analyze this codebase and update the README.md file. $ARGUMENTS
Steps
- •
Gather Context:
- •Read package.json (if exists) for name, description, scripts, dependencies
- •Read existing README.md (if exists) to understand current structure
- •Glob for src/, lib/, or app/ directories to understand project structure
- •Identify the tech stack (TypeScript, React, Node, etc.)
- •
Identify What Needs Updating:
- •Project description and features
- •Installation instructions (based on package manager)
- •Available scripts/commands
- •Configuration options
- •API documentation (if applicable)
- •
Preserve User Content:
- •Keep badges, license sections, contributing guides
- •Preserve custom sections marked with <!-- CUSTOM --> comments
- •Maintain overall document style
- •
Update README.md:
- •Use Edit tool to update specific sections
- •Keep it concise and scannable
- •Include code examples where helpful
- •Ensure all commands/scripts mentioned actually exist
- •
Report Changes:
- •Summarize what was updated
- •Note any sections that may need manual review