Individual skill
readme-builder
Creates professional README files for GitHub projects, covering purpose, installation, usage, and contribution info. Use when a repo has no README or an outdated/thin one.
skills/documentation/readme-builder/SKILL.md
Source commit d0a9928d24afb7df0fad2f2f35f65d3938a6926a
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- Yes
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Instructions only
- Last checked
- Nov 5, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 27
- Repository last updated
- Aug 20, 2026
- License
- MIT
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- claude-code Repository topic
- ai Repository topic
- ai-agents Repository topic
- ai-coding Repository topic
- ai-skill Repository topic
- ai-skill-enhancement Repository topic
- ai-skills Repository topic
- ai-skills-analysis Repository topic
- ai-skills-fest Repository topic
- ai-skills-manager Repository topic
- docs Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
README.mddoc · 1,247 bytesSKILL.mdcore · 2,241 bytesSKILL.mdcore · 2,241 bytesSKILL.mdcore · 2,241 bytesexamples/example.mddoc · 1,218 bytes
Read excerpt
## Purpose
Produce a professional, complete README for a GitHub project that lets a newcomer understand what the project is, install it, and start using it — without needing to read the source first.
## When to Use
- A repository has no README, or one that's thin/outdated.
- Preparing a project for public release or wider internal sharing.
- The user asks for "a README" for a project.
## What to Analyze / Do
1. **Determine what the project actually is** — from the codebase, package manifest, or the user's description: language/framework, what it does, its entry points.
2. **Cover the standard sections**, adapted to project type: