How do I install the Readme Badges skill?

Run npx skillmds@latest add konradcinkusz/readme-badges in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Readme Badges safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Readme Badges?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Readme Badges free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Readme Badges?

konradcinkusz (@konradcinkusz) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Readme Badges by konradcinkusz — Agent Skill

Name: Readme Badges
Author: konradcinkusz

Readme Badges

Use when writing or reviewing a README's badge block. The header metadata row and footer social block, the three badge families and which service is used for what, and the rules that keep a badge row honest: every badge a titled link, substitute owner/repo rather than copy-pasting URLs, and never badge what you do not have.

konradcinkusz Updated Sep 17, 2026

File contents

README badges

Read references/README-BADGES.md before applying any of this. That file is the standard; everything below it is a summary to help you decide whether this skill applies and to check your work afterwards.

What this standard covers

Why badges at all
The two zones
The three badge families and when each is used
The standard header row
The footer block
The rules
Worked examples

Why badges at all

A badge is a one-glance answer to a question a visitor would otherwise have to click around for: is this licensed, is it maintained, is CI green, is there a live deployment. Most badge images are live queries — the badge service fetches the repo's real state at render time — which is exactly what makes them worth having and exactly what makes a wrong one damaging: a broken or stale badge tells the visitor the repo is unmaintained more loudly than no badge would. Every rule below exists to keep the row truthful.

Generated from docs/guides/README-BADGES.md by scripts/build-marketplace.mjs. Do not edit this file: change the source document, or its entry in catalog/marketplace.catalog.json, and re-run the generator.

Frequently asked questions