readme-genlisted
Install: claude install-skill SilviaAre95/wayworks
# README Generator
Generate the README in the requested style: **$ARGUMENTS** (defaults to standard)
## Steps
1. **Analyze the project**:
- Read `package.json` / `pyproject.toml` / `go.mod` for project metadata
- Read existing README if present (preserve custom sections)
- Scan directory structure for architecture insights
- Check for existing docs (API docs, guides, ADRs)
- Identify the tech stack from dependencies
2. **Generate sections based on style**:
### Minimal
- Project name + one-line description
- Quick start (install + run)
- License
### Standard (default)
- Project name + description
- Tech stack badges
- Prerequisites
- Installation
- Development (run, test, lint)
- Project structure (key directories only)
- Environment variables (from `.env.example`)
- Deployment
- Contributing
- License
### Detailed
- Everything in Standard, plus:
- Architecture overview
- API documentation summary
- Database schema overview
- CI/CD pipeline description
- Troubleshooting
- Changelog or link to releases
3. **Generate environment variable documentation**:
- Read `.env.example` if it exists
- Document each variable with description, required/optional, example value
- Group by category (database, auth, external services)
4. **Write the README**:
```markdown
# Project Name
Brief description of what this project does.
## Tech Stack
- **Runtime**: Node.js 20
- **Framework**: Next.js 14 (App Router)
- **Database**: PostgreSQL + Prisma
- **Styling**: