From the author
When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architecture, and deployment.
Install
npx skills add aiskillstore/marketplace --skill readme -a claude-code
Installs to .claude/skills/readme/ · Each command fetches the skill straight from GitHub with the open skills CLI.
No download: this skill’s licence (No licence) does not let us redistribute its files. The install commands fetch them from GitHub instead.
Want your agent to suggest skills while you type? See how to use skills from your IDE.
Safety checks on SKILL.md
- Uses sudoLow
Why 77
aiqbench computes the trust score from public signals. It is not a security audit, so read a skill before you install it.
Similar skills
Closest to this one by what they do and when they are used.
- good-readmeOutlineDriven/outline-driven-developmentUse when the user asks to create, rewrite, review, or polish an open-source README, including shop-window READMEs. Not for remote, credential, publish, deploy, or irreversible changes.DevOps★ 54
- readme-generatorserejaris/personal-corp-osUse when creating or rewriting README.md for projects. Triggers on "write README", "create README", "update README". Creates human-focused documentation with proper structure.Writing★ 236
- write-docsdzhng/skillsWrite and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code. Use when creating or revising a README; when a doc enumerates exact scenes, scenarios, helpers, class ids, file lists, or command/flag matrices the code already holds; when trimming narrative or changelog out of a doc; or when deduplicating overlapping docs and wiring a root doc to its sub-docs.Writing★ 1.4K
- crafting-effective-readmessoftaworks/agent-toolkitUse when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.Writing★ 2.6K
- readoutOutlineDriven/outline-driven-developmentUse when a user wants a readable, shareable HTML document of findings. Not for remote, credential, publish, deploy, or irreversible changes.DevOps★ 54
- developer-documentationNateBJones-Projects/developer-documentation-skillCreate, restructure, or maintain accurate developer documentation for software, tools, automations, packages, APIs, SDKs, CLIs, installations, migrations, operations, and troubleshooting. Use when the user asks for a README, overview, quickstart, tutorial, how-to guide, concept page, reference, API or CLI documentation, installation guide, runbook, migration guide, release notes, troubleshooting page, or a complete documentation set.Engineering★ 81
Ratings & reviews
—
no reviews
Tried this skill? Rate it to help others. Sign in
Discussion
Join the discussion. Sign in