readme
Installation
SKILL.md
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
How to use
Invoke me directly with /readme:
/readme- generate a new README for the project/readme update- update existing README based on recent changes/readme minimal- create a bare-bones README/readme detailed- include all possible sections