Show HN: I audited my own eight repos. Half of them lied in the README

Category: devtools

Tags: readme, testing, documentation-validation

Score: 6.3/10 (Innovation: 7, Technical: 5, Documentation: 8, Utility: 5)

readme-check is a tool that verifies console commands in README files still produce the output they claim, detecting stale or false documentation. It focuses on falsifiable claims like test counts and benchmark numbers, using a pragmatic matching strategy that tolerates minor variations but flags missing promises. Its self-checking design and honest approach to common documentation pitfalls make it a novel and practical utility for maintaining accurate docs.

Target audience: backend devs, devops, software engineers

Repository: https://github.com/Wasserpuncher/readme-check · Python · MIT

View on Hacker News