Ready to supercharge your AI agents?

Install any skill in seconds. Free to start, no credit card required.

Get Started Free →

README Audit · archive228 | DecimalAI

documentationby archive228

README Audit

archive228/readme-audit

Source archive228/loopkit ↗License MIT

Check whether a README actually lets a stranger run the project.

SkillScore96Maintained

Automatic

Doc Ops pack

Last verified 8/16/2026

What it changes

Passed 22 of 23 test cases with the skill, and 18 of 23 without it.

Without skill78%

With skill96%

Checks it passed that the model alone missed

Recommends removing badges.
Advises cutting project badges.
Recommends removing long philosophy text.

and 4 more in the full report

4 fixed18 passed either way1 still failing0 broke

Pass-rate lift: +17 pp
Tokens: -24%
Agent turns: 0%
Response time: -37%

Model gemini-3.6-flashMeasured 8/16/2026v122 of 23 cases passed with skill

Tokens, turns and time describe resource use, not a dollar price.

Use this skill

Save it into your project's skills folder. Claude Code picks it up in its next session.

curl -fsSL --create-dirs -o .claude/skills/archive228-readme-audit/SKILL.md https://app.decimal.ai/s/archive228-readme-audit/SKILL.md

Want it pinned and updatable? pip install "decimalai>=0.15", then decimalai skills add archive228-readme-audit, and start Claude Code with claude --plugin-dir "$(git rev-parse --show-toplevel)/.agents"

1 · One-time — install the CLI (docs ↗)

pip install "decimalai>=0.15"

2 · Get the skill — writes .agents/skills/archive228-readme-audit/ and pins it in .decimal/skills.lock

decimalai skills add archive228-readme-audit

No CLI? Get the same file — curl · raw file

curl -fsSL --create-dirs -o .claude/skills/archive228-readme-audit/SKILL.md https://app.decimal.ai/s/archive228-readme-audit/SKILL.md

Raw file: /s/archive228-readme-audit/SKILL.md ↗ · machine-readable summary at /s/archive228-readme-audit.json ↗

Safety checks: 3 of 3 passed

Code scan CleanIntent PassedContent Clean

See it in action

One of 4 test cases the skill fixed. Same model, same prompt, with and without the skill.

1 of 4

Prompt

Please critique this attached README text for a CLI tool we are launching. We want to ensure it isn't bloated and effectively guides a newcomer from setup to execution. Highlight the specific deficiencies you spot and supply the exact content or code corrections needed.

What was checked, without and with the skill
Checked	Without skill	With skill
Recommends removing badges.	Missed	Passed
Recommends removing long philosophy text.	Missed	Passed

case-03 · gemini-3.6-flash · 8/16/2026 · answers are capped and redacted

What's inside

The instructions your model reads when the skill loads.

SKILL.md9 linessingle file

README Audit

A README's only job: a stranger clones it and gets to "it works" without asking you. Check, in order:

One sentence on what it is and who it's for — above the fold.
Install — copy-paste commands that actually work on a clean machine. Test them mentally step by step.
Run / quickstart — the smallest end-to-end example.
Config — required env vars, where secrets go.
No rot — does it reference files/commands/flags that still exist? Stale README is worse than none. Cut: long philosophy, badges nobody reads, TODO sections. Output: the specific gaps + the fix.

Track record

Benchmark

22 / 23

test cases passed, vs 18 / 23 without

Adoption

Users: 5
Times used: 57

Safety and source details

SkillSafety

✓ 3 of 3 passed

Code scan15 of 15 checks clean

0 critical · 0 warning · 0 info — scanner v4 — 8/3/2026

View 15 scanner checks

live_secretremote_code_executionreverse_shelldata_exfiltrationssrf_metadataagent_snoopinganti_refusaldestructive_commandsobfuscated_unicodeunicode_homoglyphopaque_blobsuspicious_urltool_overreachtrigger_abuseprompt_injection_phrasing

IntentSafe

LLM judge · does the skill do what it claims

ContentClean

LLM judge · policy & harmful-content review

Source

Imported

archive228 / loopkit

skills/readme-audit/SKILL.md

View on GitHub ↗

License MITImported 8/3/2026Version v1

More skills from the same source and nearby in the registry, with their headline benchmark lift.

Ready to supercharge your AI agents?

See it in action

What's inside

README Audit

Track record

Benchmark

Adoption

SkillSafety

Source

Related skills