← All skills

readme-best-practices

97 / 100 · Low risk

Fine to try. Some of what it can do is expected: a coding skill usually runs build and test commands.

By Mindrally/skills (GitHub) · coding · 301 stars · scanned at commit 7682ca7

Structure, tone, and content conventions for writing effective project README files, covering hooks, quick starts, feature presentation, badges, and common documentation sections. Use when writing a new README, rewriting an existing one, or reviewing README quality for a repository, library, or CLI tool.

Works with any agent that supports SKILL.md skills.

What this skill can do

Install

Paste this into your terminal. It downloads exactly the version we scanned, not whatever is newest.

if [ -e ~/.agents/skills/'readme-best-practices' ] || [ -L ~/.agents/skills/'readme-best-practices' ]; then echo 'A skill folder named readme-best-practices already exists — not replacing it' >&2; false; else d=$(mktemp -d) && git clone --quiet --filter=blob:none --no-checkout 'https://github.com/Mindrally/skills' "$d" && git -C "$d" checkout --quiet '7682ca77710e0971eab4e0ae5dddfa281aea0ba5' -- 'readme-best-practices' && mkdir -p ~/.agents/skills && cp -R "$d"/'readme-best-practices' ~/.agents/skills/'readme-best-practices' && rm -rf "$d"; fi

Codex reads ~/.agents/skills directly. For Claude Code, Cursor, Copilot, Gemini CLI, Antigravity or OpenCode, also link it. For Claude Code: ln -s ~/.agents/skills/'readme-best-practices' ~/.claude/skills/'readme-best-practices' (other agents: ~/.cursor/skills, ~/.copilot/skills, ~/.gemini/skills, ~/.gemini/config/skills, ~/.config/opencode/skills). Or install through the finder skill, which does both.

Badge for your README

The badge for Mindrally/skills shows the score of its lowest-scoring skill.

[![SkillTrust](https://zalavijaysinh.github.io/skilltrust/badges/Mindrally/skills.svg)](https://zalavijaysinh.github.io/skilltrust/repos/Mindrally/skills/)

Score history