Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
Check whether a README actually lets a stranger run the project.
Install Readme Audit
$ npx skills add Archive228/loopkit --skill readme-audit -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install Archive228/loopkit readme-audit --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/Archive228/loopkit.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/readme-audit .claude/skills/readme-audit && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "readme-audit" agent skill from https://github.com/Archive228/loopkit/tree/main/skills/readme-audit into .claude/skills/readme-audit/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-audit", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/Archive228/loopkit/tree/main/skills/readme-auditType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add Archive228/loopkit --skill readme-audit -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install Archive228/loopkit readme-audit --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Archive228/loopkit.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/readme-audit .agents/skills/readme-audit && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "readme-audit" agent skill from https://github.com/Archive228/loopkit/tree/main/skills/readme-audit into .agents/skills/readme-audit/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-audit", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add Archive228/loopkit --skill readme-audit -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install Archive228/loopkit readme-audit --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Archive228/loopkit.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/readme-audit .cursor/skills/readme-audit && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "readme-audit" agent skill from https://github.com/Archive228/loopkit/tree/main/skills/readme-audit into .cursor/skills/readme-audit/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-audit", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/Archive228/loopkit.git --path skills/readme-audit--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add Archive228/loopkit --skill readme-audit -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install Archive228/loopkit readme-audit --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Archive228/loopkit.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/readme-audit .gemini/skills/readme-audit && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "readme-audit" agent skill from https://github.com/Archive228/loopkit/tree/main/skills/readme-audit into .gemini/skills/readme-audit/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-audit", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install Archive228/loopkit readme-auditInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add Archive228/loopkit --skill readme-audit -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/Archive228/loopkit.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/readme-audit .github/skills/readme-audit && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "readme-audit" agent skill from https://github.com/Archive228/loopkit/tree/main/skills/readme-audit into .github/skills/readme-audit/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-audit", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add Archive228/loopkit --skill readme-audit -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install Archive228/loopkit readme-audit --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/Archive228/loopkit.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/readme-audit .opencode/skills/readme-audit && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "readme-audit" agent skill from https://github.com/Archive228/loopkit/tree/main/skills/readme-audit into .opencode/skills/readme-audit/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-audit", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
readme-audit- GitHub stars
- 755
- Token cost
- ~207 tokens
- SKILL.md length
- 97 words
- Files
- 1
- Skills in repo
- 43
- Repo updated
- First seen
- Licence
- MIT
At a glance
Check whether a README actually lets a stranger run the project.
- Works in 5 steps: One sentence on what it is and who it's… → Install — copy-paste commands that… → Run / quickstart — the smallest… → …
- Tasks that involve Technical documentation
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Readme Audit is an agent skill from Archive228/loopkit. Check whether a README actually lets a stranger run the project. Use on any repo's README before publishing.
Its SKILL.md is about 210 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation. The repository describes itself as: 33 battle-tested skills + minimal .claude harness for any coding agent (Claude Code, Cursor, Codex, Gemini CLI). The licence is MIT.
When your agent uses it
- Tasks that involve Technical documentation
Example prompts
- “/readme-audit”
Workflow steps
5 steps, taken from the first numbered list in SKILL.md.
- 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.
What it can do on your machine
Read from SKILL.md and the folder at commit 5ae033e. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Readme Audit loads about 207 tokens when it runs. Until then it costs about 30 tokens; SKILL.md has 97 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from Archive228/loopkit at commit 5ae033e, republished under its MIT licence (© Archive228). 97 words, ~207 tokens.
Download SKILL.mdSave it as
.claude/skills/readme-audit/SKILL.md (or your agent's skills folder).- name
- readme-audit
- description
- Check whether a README actually lets a stranger run the project. Use on any repo's README before publishing.
- when_to_use
- publishing a repo, onboarding docs, "is the README good"
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.
© Archive228, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in skills/readme-audit of Archive228/loopkit.
Open the folder on GitHubat commit 5ae033e
Compare with similar skills
Readme Audit next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Readme Audit this skillArchive228/loopkit | 755 | — | ~207 | Automated safety check: Pass | MIT | |
| Diagram Designcathrynlavery/diagram-design | 47k | 1 repos | ~7.5k | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Doc SyncJetBrains/ideavim | 10k | 2 repos | ~2.6k | Automated safety check: Pass | MIT | |
| Mailspring App ScreenshotsFoundry376/Mailspring | 18k | — | ~1.5k | Automated safety check: Pass | GPL-3.0 | |
| Draw.io Diagram StudioAgents365-ai/drawio-skill | 10k | — | ~2.4k | Automated safety check: Notes | MIT |
Similar skills
Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
- Official
Doc Sync
JetBrains/ideavim
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
Mailspring App Screenshots
Foundry376/Mailspring
Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
Dark Architecture Diagram Builder
Cocoon-AI/architecture-diagram-generator
Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.
More from Archive228/loopkit
All 43 skills in this repoHitl Escalate
Archive228/loopkit
Escalate blocked runs to a human via configured channel or fallback to BLOCKED.md and exit the loop.
Structured Output
Archive228/loopkit
Get JSON out of the model reliably. An agent skill from Archive228/loopkit.
Using Loopkit
Archive228/loopkit
A skill your agent uses when starting any conversation in a loopkit-enabled project - establishes how to find and use loopkit's 49 skills, requiring skill invocation before ANY response including…
Active Memory Reminder
Archive228/loopkit
Before compaction Loopkit extracts decisions into claude-decisions.json (machine-readable).
Eval Harness
Archive228/loopkit
Build a repeatable eval loop that grades agent output with an LLM judge, so prompt/skill changes get scored against a baseline instead of eyeballed.
Feature List JSON
Archive228/loopkit
Enumerate every end-to-end feature as strict JSON entries with passes:false, editable-passes-only discipline, and priority order.
Related
Categories
Questions about Readme Audit
What does Readme Audit do?
Check whether a README actually lets a stranger run the project. Readme Audit is an agent skill from Archive228/loopkit. Check whether a README actually lets a stranger run the project.
When should I use Readme Audit?
Readme Audit fits situations like: tasks that involve Technical documentation.
How do I install Readme Audit in Claude Code?
Run `npx skills add Archive228/loopkit --skill readme-audit -a claude-code`. Or copy the skill folder (skills/readme-audit in Archive228/loopkit) into .claude/skills/readme-audit in your project. Claude Code loads it when a task matches its description.
How do I install Readme Audit in Codex?
Run `npx skills add Archive228/loopkit --skill readme-audit -a codex`. Or copy the skill folder (skills/readme-audit in Archive228/loopkit) into .agents/skills/readme-audit in your project. Codex loads it when a task matches its description.
Can I use Readme Audit in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add Archive228/loopkit --skill readme-audit -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme-audit, .gemini/skills/readme-audit, .github/skills/readme-audit and .opencode/skills/readme-audit in your project.
What does Readme Audit need to run?
SKILL.md names no scripts, command-line tools or credentials: Readme Audit is instructions for the agent only.
Does Readme Audit access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Readme Audit safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Readme Audit use?
Readme Audit is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Readme Audit use?
About 207 tokens (SKILL.md is roughly 828 characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Readme Audit?
Skills that share tags, products or a category with Readme Audit: Diagram Design (cathrynlavery/diagram-design, 47k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Readme Audit?
Archive228 (a GitHub user) maintains it in Archive228/loopkit, which has 755 GitHub stars. The repository holds 43 skills in this directory. The repository was last updated on July 14, 2026.
Source: Archive228/loopkit on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.