READMEs go stale quietly. A script gets renamed, a file moves, npm run start stops existing, and nobody notices until a new contributor trips over it.
README-rot checks your README against the actual repo and reports dead links and anchors, missing files, npm run scripts and make targets that don't exist, env vars that no code reads, and drift since the README was last touched. It suggests the likely new path when a file moved ("did you mean src/app/server.py?"), annotates the lines directly in your PR, and gives a freshness score.
It's a single Python file with zero dependencies, and it's on the Marketplace: uses: UE5test1/README-rot@v1.
It's v0.2, so I'd love to hear about false positives on real READMEs.
Top comments (0)