github-readme
Skill4 starsChanged 7 months agoMITView on GitHub
Generate or improve a project README.md for open-source presence and GitHub visibility. Auto-invoked when user says "write readme", "improve readme", "github readme".
We split this skill into the rules it gives an agent
2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 14
Read package.json/pyproject.toml/Cargo.toml for project metadata
- Distinctive: line 18
Write a README with these sections:
≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Generate a professional README for this project right now.
Target: $ARGUMENTS (project path, defaults to current directory)
Steps:
- Read package.json/pyproject.toml/Cargo.toml for project metadata
- Scan the source directory structure
- Understand the project's purpose, tech stack, and features
Write a README with these sections:
- Title + one-line description
- Badges (build, coverage, license, version — use shields.io format)
- Features — Key capabilities as bullet points
- Quick Start — Install + basic usage, must work with copy-paste
- Usage Examples — 2-3 common use cases with code blocks
- Architecture — Brief overview for contributors
- API Reference — If applicable
- Contributing — How to contribute
- License
Make it scannable: heavy headings, code blocks, tables. Optimize title/description for GitHub search.
Other versions2 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 2
- xinran-dwi/skills★ 1same name
- Windrunner20/github-readme-skill★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository31 other files it gives its agents.
- .claude/CLAUDE.mdCLAUDE.md
- CLAUDE.mdCLAUDE.md
- global/CLAUDE.mdCLAUDE.md
- auditSkill
- case-studySkill
- ci-commentSkill
- cold-outreachSkill
- daily-briefingSkill
- dep-checkSkill
- hub-statusSkill
- invoice-genSkill
- kronus-helpSkill
- kronusSkill
- kronus-troubleshootSkill
- lead-qualifySkill
- linkedin-postSkill
- manifest-validateSkill
- meeting-notesSkill
- planSkill
- profile-optimizeSkill
- project-summarySkill
- quick-reviewSkill
- reviewSkill
- secret-scanSkill
- seo-articleSkill
- standup-updateSkill
- telegram-projectSkill
- test-genSkill
- test-runSkill
- testSkill
- upwork-proposalSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.