readme-generator - Generate portfolio-grade GitHub READMEs
Generates concise GitHub README.md files from project context, with optional visual assets, an MIT license, and GitHub metadata recommendations.
Tags
Updated: 2026-10-07Capabilities
Typical Inputs
Typical Outputs
What this skill does
- Inspect project files
- Identify project type
- Extract project narrative
- Select visual strategy
- Generate README visuals
- Compress visual assets
- Assemble README.md
- Create MIT license
- Recommend GitHub metadata
- Validate README output
Inputs
- Project directory
- Existing README.md
- Project manifests
- Documentation files
- Entry-point files
- Examples and demo assets
- User request and preferences
Outputs
- Generated README.md
- README visual assets
- Compressed image files
- MIT LICENSE
- GitHub Description recommendations
- GitHub Topics recommendations
- Optional gh CLI update suggestions
Requirements
- Project directory access
- File-system write permission
- Image generation support when preferred
- HTML/CSS rendering tools for fallback visuals
- WebP conversion tool for WebP output