rrreadmereality

README CHECKS. REPOSITORY EVIDENCE.

Your README is a promise.
Check the small print.

Catch missing files and broken quickstart references.
No model. No key. No commands executed.

01 / TRY IT BELOW

Same rules in the browser,
your terminal, and CI.

THE WORKBENCH

A quickstart, under inspection.

● Built-in examples · runs locally
▤ README.md

SNAPSHOT FILES
    Read-only snapshot. Edit the README to experiment.
    Inspection report

    Passing a static check proves a file or declaration exists. It does not prove a command will run.

    TAKE IT TO YOUR REPOSITORY

    Small check.
    Useful evidence.

    Download the release bundle, then inspect a local checkout.
    All processing stays on your machine.

    Get the release bundle ↗
    LOCAL TERMINAL
    $ node dist/cli.mjs check .
    README.md:8  RR002
    Named script is not declared.
    Evidence: package.json
    Candidates: dev, build
    
    1 passed · 1 error · 0 not checked

    Example output, shown for illustration.