mcpField
W
write-root-readme

write-root-readme

github.com/liblafDevelopment0184 installsUpdated 6w ago
Repository

About write-root-readme

An Agent Skill for developers writing a repository’s root README.md. It gives concrete guidance on structure, badges, links, and validation.

Key features

  1. 01Rewrite the root README.md
  2. 02Follow a reference structure and style
  3. 03Add badges and a project image
  4. 04Check commands, links, and tool names

Use cases

  1. 01Create a repository’s root README
  2. 02Make a comprehensive README rewrite
  3. 03Verify commands and links against repository files

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/liblaf/skills --skill write-root-readme

After installing, type/write-root-readmein Claude Code to confirm it loaded.

Bundled filesagents/openai.yamlreferences/example-readme.md

Details

From the project README

Write Root README

Guidelines

  • files to update:
    • README.md in the repo root
  • Read 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.

Comments

Markdown supported