write-root-readme
Write Root README
Guidelines
- files to update:
README.mdin 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.
More from liblaf/skills
write-python-tests
Write or refresh tests for Python projects. Use when Codex needs to add coverage, replace stale tests, reorganize tests under `tests/`, or lock down Python behavior from source code in repos that use `nox`, `pytest`, and `mise`.
34rewrite-python-docs
Rewrite Python docs and docstrings from source code. Use when Codex needs to refresh the docs.
34write-conventional-commit
Generate exactly one high-quality Conventional Commit message from the current Git diff. Use when Codex needs to inspect staged changes, summarize the dominant intent, and return only the final commit message with no analysis or extra text.
33sync-github-repo-metadata
Inspect a repository and propose or apply GitHub About metadata updates. Use when Codex needs to infer a concise repository description and topic set from source code, package metadata, docs config, or the current README, then preview and optionally run `gh repo edit`.
33automate-project-maintenance
Orchestrate repository maintenance. Use when Codex needs one entry point to refresh tests, docs, README, and GitHub metadata.
33