readme-generator
Installation
SKILL.md
README Generator
Generate a clear, developer-friendly README.md by analyzing a project's actual files — not generic boilerplate. The output should reflect what the project actually does.
Step 1 — Gather Project Context
Before writing anything, collect as much signal as possible. Read these files if present:
| Priority | Files to read |
|---|---|
| High | package.json, pyproject.toml, Cargo.toml, go.mod, composer.json |
| High | index.js, main.py, app.py, src/index.*, cmd/main.go, src/main.* |
| Medium | .env.example, .env.sample, config.example.* |
| Medium | Makefile, Dockerfile, docker-compose.yml |
| Medium | CONTRIBUTING.md, LICENSE, CHANGELOG.md (if exists, link don't duplicate) |
| Low | src/ or lib/ folder structure (top 2 levels only) |