# Write Root Readme

> Write or rewrite the repo-root README.md.

- Skill: `liblaf/write-root-readme` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add liblaf/write-root-readme`
- Raw SKILL.md: https://api.skillmd.com/api/skills/liblaf/write-root-readme/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: liblaf (https://skillmd.com/u/liblaf)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/liblaf/write-root-readme

---


# Write Root README

## Guidelines

- files to update:
  - `README.md` in the repo root
- Read [example-readme.md](./references/example-readme.md) for a reference structure and style.
- Badges are encouraged. See example README for useful badges.
  - Prefer badges in example README when applicable.
  - Prefer badges with live data over static badges.
- Emojis are encouraged in headers.
- Hero section is encouraged. Follow the format in example README strictly.
  - Use GitHub Socialify to generate a project image. The generated image already includes logo, title, description, badges for stars, forks, issues, pulls.
  - Include link to docs if exists.
  - Badges in hero section are encouraged. Limit hero section to 8 badges.
  - Limit hero section to 4 links.
  - Include a rule after hero section.
- License section is encouraged. Follow the format in example README strictly.
- DO NOT use relative links in README.
- Favor bold, comprehensive rewrites over minor or incremental edits.
- Keep README concise.

## Validation

- Run `rumdl fmt .`. Treat its findings as weak hints, not strong constraints.
- Spot-check commands, links, and tool names against the actual repo files before finishing.