| name | rawr-create-readme |
| description | Use when a new project has been completed - creates a README.md in the project folder |
Create README
Rules
- Frame it as personal interest - curiosity, a problem you wanted to solve, something you wanted to learn.
- Plain language - no buzzwords, no jargon
- Short and scannable - use headers and bullets; no walls of text
- Justify the project - answer "why does this exist?" in one or two sentences up top
Structure
# Project Name
One or two sentences: what it is and why it was built.
## What it does
- Bullet point feature
## How it works
Mermaid diagram explaining the key logic or data flow. Use `flowchart TD` for request/data flows, `sequenceDiagram` for multi-party interactions, or `stateDiagram-v2` for state machines. Choose whichever best fits the project.
## Getting Started
How to get the project up and running.
## What I learned
Short paragraph - what you learned from building it.
## Future Improvements
A few dot points on improvements/additions that could take the project to the next level.
## Tech
- Key technologies used and why they were chosen - include a link to the documentation for each technology.
What to avoid
- "This project demonstrates my skills in..."
- Long paragraphs
- Setup instructions unless the project needs them
- Badges, shields, or decorative elements
