Skills
.Work. You
Rest

README Reality Check

Community

Ensure README matches repo reality.

Software Engineering#code quality#documentation#verification#readme#auditing#release readiness
Authorjimmymalhan
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

scripts

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: README Reality Check
Download link: https://github.com/jimmymalhan/codereview-pilot/archive/main.zip#readme-reality-check

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.