skills.rest
jimmymalhan
jimmymalhanCOMMUNITY
Explore all skills by this author →
GitHub

README Reality Check

Validate README.md claims against package.json, source code, and test outputs.

1|Updated Mar 7, 2026
Search Tags:#code quality#documentation#verification#readme#auditing#release readiness
One-click install
npx skills add https://github.com/jimmymalhan/codereview-pilot --skill readme-reality-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: README Reality Check
Source: https://github.com/jimmymalhan/codereview-pilot/tree/main/.claude/skills/readme-reality-check
Command: npx skills add https://github.com/jimmymalhan/codereview-pilot --skill readme-reality-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automatically verifies that the project's README.md accurately reflects the current state of the codebase, preventing outdated information and misleading claims.

Core Features & Use Cases

  • Claim Verification: Checks if commands, features, and progress metrics mentioned in the README are present and correct in the repository.
  • Staleness Detection: Identifies discrepancies between README statements and actual project status (e.g., missing scripts, incorrect version numbers).
  • Use Case: Before releasing a new version, run this Skill to ensure the README's installation instructions still work, the version number is updated, and any new features are documented.

Quick Start

Run the README Reality Check skill to verify all claims in the README.md file.

Frequently Asked Questions about README Reality Check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I verify my README matches the actual repository state?▼

To verify your README matches the repository state, run an auditing check that compares README claims against package.json, source code, and test outputs to detect discrepancies in commands, features, and version numbers.

What is README documentation auditing for release readiness?▼

README documentation auditing for release readiness is the process of validating README.md content accuracy and currency against the actual codebase, preventing outdated information and misleading claims before a new release.

How do I check if README installation instructions still work?▼

You can check if README installation instructions still work by running a staleness detection script that identifies discrepancies between README statements and actual project status, including missing scripts and incorrect version numbers.

Can I detect outdated version numbers and missing scripts in my README?▼

Yes, you can detect outdated version numbers and missing scripts by comparing README claims with the actual package.json and source code to ensure documentation integrity and identify staleness.

What are the limitations of automated README verification?▼

The limitations of automated README verification include relying on specific file comparisons, meaning it primarily detects discrepancies in commands, features, version numbers, and progress metrics rather than validating subjective documentation quality.

Related Skills

Explore More Software Engineering Skills→
grahama1970grahama1970
1

treesitter

Parse source files to extract functions, classes, and symbols into structured JSON.

Community
Intermediate
Nairon-AINairon-AI
7

flux-release

Synchronize release version numbers across Flux manifest files and generate aligned release notes.

Official
Advanced
grad13grad13

tests-to-code

Validates and synchronizes code with tests using static analysis and execution diagnostics.

Community
Advanced
dalawwadalawwa

ddd:setup-code-formating

Create a code formatting configuration and embed it in CLAUDE.md.

Community
Basic