Skill

validate-readme

Validate all README files in the repository for required sections and installation code blocks. Checks section presence using config from .readme-validator.yaml or sensible defaults. Badge URL reachability is checked on-demand via WebFetch.

Install

npx claudepluginhub jacobpevans/claude-code-plugins --plugin content-guards

Tool Access

This skill uses the workspace's default tool permissions.

Preview

SKILL.md

Similar Skills

angular-new-app

Creates new Angular apps using Angular CLI with flags for routing, SSR, SCSS, prefixes, and AI config. Follows best practices for modern TypeScript/Angular development. Use when starting Angular projects.

angular-angular-1

100.1k

angular-developer

20 files

Generates Angular code and provides architectural guidance for projects, components, services, reactivity with signals, forms, dependency injection, routing, SSR, ARIA accessibility, animations, Tailwind styling, testing, and CLI tooling.

angular-angular-1

100.1k

context7-cli

3 files

Executes ctx7 CLI to fetch up-to-date library documentation, manage AI coding skills (install/search/generate/remove/suggest), and configure Context7 MCP. Useful for current API refs, skill handling, or agent setup.

upstash-context7-1

53.8k

Stats

Parent Repo Stars2

Parent Repo Forks0

Last CommitMar 22, 2026

Actions

View Source View Plugin View on GitHub View README

Validate README

Run a comprehensive audit of all README.md files in the current repository.

Usage

/validate-readme

Steps

1. Find all README files

Find all README*.md files in the repository, excluding .git/ and .claude/ directories.

2. Validate each README

For each README found, check:

Required sections present (from .readme-validator.yaml or defaults)
Installation section contains at least one code block
Optional sections present (warnings only)

Badge URL reachability may be checked on-demand using WebFetch for any badge images found in the README.

3. Report results

Output a summary table:

File	Status	Issues
./README.md	PASS	--
./plugin/README.md	WARN	Missing: Contributing

Configuration

Place a .readme-validator.yaml file anywhere in the directory tree above the README being validated. The hook searches upward up to 10 levels.

required_sections:
  - Installation
  - Usage
optional_sections:
  - Contributing
  - License
  - API

Defaults (used when no config file is found):

required_sections: Installation, Usage
optional_sections: Contributing, License, API

Related Skills

code-quality-standards (code-standards) — broader code quality standards that include documentation requirements