Generate or refresh a comprehensive, professional README.md for a repository, with architecture overview, mermaid and o…
Part of AI Doc GenPack · 3 skills
by divar-ir· WritingUnclaimed · Yours? Claim it
About
Generate or refresh a comprehensive, professional README.md for a repository, with architecture overview, mermaid and optional C4 diagrams, repository structure, dependencies, and API documentation. Use whenever the user asks to create, write, update, improve, or regenerate a README, project documentation, or a project overview page — even if they just say "document this project" or "this repo needs docs".
Skills people install alongside generate-readme.
Runs on your machine.
Runs on your machine.
Runs on your machine.
Runs on your machine.
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.copilot/skills/generate-readme
Runs on your machine.
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.cursor/skills/generate-readme
Runs on your machine.
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.claude/skills/generate-readme
/plugin marketplace add divar-ir/ai-doc-gen /plugin install ai-doc-gen@divar
Runs on your machine.
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.agents/skills/generate-readme
Runs on your machine.
Runs on your machine.
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.gemini/skills/generate-readme
Runs on your machine.
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme .agents/skills/generate-readme
Runs on your machine.
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.openclaw/skills/generate-readme
Runs on your machine.
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.config/opencode/skills/generate-readme
Runs on your machine.
npx -y degit divar-ir/ai-doc-gen/skills/generate-readme ~/.hermes/skills/generate-readme
Scanned and passed · checked 3 h ago
From people who use it
Step by step
Nothing new reaches your agent until a person has looked at it.
Scanned on every change, and again when our rules improve.
No reviews yet. Used generate-readme? Say how it went.
Write a reviewRewrites AI-sounding text so it reads like a person wrote it, without changing what it says or making anything up.
Two documentation skills: HADS, a tagging convention people and AI both read well, and grounded vaults that trace every claim to its source.
Tw93's writing skill: rewrites and polishes Chinese or English prose so it reads naturally, cutting stiff, AI-sounding phrasing.
Nobody has shared how they use generate-readme yet.
Security scan
Passed
Safe to install in every agent it supports. Runs in your agent, as instructions.