readme-forgelisted
Install: claude install-skill tanmayai23/README-Editor-skill
# readme-forge
Write READMEs that are **true to the code**, **fast to scan**, and **correct for the platform** they render on.
Skill directory: `SKILL_DIR` = the folder containing this file. Scripts are stdlib-only Python 3.8+ (`python` or `python3`).
## Step 0 — Pick the mode
| User wants | Mode | Read first |
|---|---|---|
| README for a code project (new or from scratch) | **A. Project** | `references/project-readme.md` |
| Hugging Face model / dataset / Space | **C. Hugging Face** | `references/huggingface.md` |
| "Improve / review / fix / audit my README", "is it accurate?" | **D. Audit** | `references/quality-rubric.md` |
| Same README for PyPI / npm / HF / GitLab | **E. Port** | `references/platforms.md` |
| CONTRIBUTING, SECURITY, CITATION, CHANGELOG, templates | **F. Companion docs** | `templates/extras/` |
| GitHub profile README, animated banner/header/footer, CTA buttons, "make it look amazing" | **Design** | the **readme-forge-design** skill (see below) |
Modes combine (e.g. A + C for an ML repo that ships to GitHub and HF; A + F for "make this repo open-source ready"). Always also apply `references/writing-style.md`.
**Design and profiles live in a separate, optional skill.** If the user asks for a banner, a visual redesign or a GitHub profile README, use the `readme-forge-design` skill when it is available. If it isn't installed, say so in one line (`claude plugin install readme-forge-design --marketplace tanmayai23/README-Editor-skill`) and write a plain