readme-generation
Skill0 starsChanged 3 months agoMITView on GitHub
Use when writing, rewriting, or auditing a GitHub README.md — generate high-converting README with badges, SVG logo, and 2026 best-practice audit.
2 other projects use a version of this.
Adopted by
Most recently taken up by
- gray-matter/skillstheir own version, first seen Oct 4, 2026
- LiuRoi/skillstheir own version, first seen Mar 24, 2026
Other versions2 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 2
- LiuRoi/skills★ 1same name
- gray-matter/skills★ 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 repository64 other files it gives its agents.
- subagent-driven-developmentSkill
- crazy-skills-catalogSkill
- frontend-designSkill
- system-architectureSkill
- git-workflow-and-versioningSkill
- using-git-worktreesSkill
- documentation-and-adrsSkill
- accessibilitySkill
- adverse-reviewSkill
- aeoSkill
- agent-designerSkill
- api-and-interface-designSkill
- best-practicesSkill
- browser-testing-with-devtoolsSkill
- canvas-designSkill
- ceo-advisorSkill
- ci-cd-and-automationSkill
- content-creatorSkill
- context-engineeringSkill
- create-voltagentSkill
- cto-advisorSkill
- deep-researchSkill
- doubt-driven-developmentSkill
- frontend-ui-engineeringSkill
- gdprSkill
- idea-refineSkill
- incremental-implementationSkill
- interview-meSkill
- iso27001Skill
- local-seo-managerSkill
- mcp-server-builderSkill
- observability-and-instrumentationSkill
- performanceSkill
- planning-and-task-breakdownSkill
- product-manager-toolkitSkill
- research-orchestratorSkill
- saas-metrics-coachSkill
- seoSkill
- soc2Skill
- source-driven-developmentSkill
- spec-driven-developmentSkill
- tech-debt-trackerSkill
- voltagent-best-practicesSkill
- voltagent-core-referenceSkill
- voltagent-docs-bundleSkill
- web-quality-auditSkill
- using-crazy-skillsSkill
- writing-skillsSkill
- core-web-vitalsSkill
- performance-optimizationSkill
- context-compressionSkill
- prompt-enhancementSkill
- token-efficiencySkill
- systematic-debuggingSkill
- test-driven-developmentSkill
- verification-before-completionSkill
- receiving-code-reviewSkill
- requesting-code-reviewSkill
- security-and-hardeningSkill
- brainstormingSkill
- The first 60 shown.
The file
Files
README Generation
High-converting GitHub README generator. Composite of d-o-hub/github-template-ai-agents readme-best-practices + github/awesome-copilot readme-blueprint-generator.
When to use
- User asks to "write the README", "improve README", "add badges", "make repo look professional"
- Creating a new repo and need first README
- Auditing an existing README for 2026 best practices
Workflow
- Analyze repo —
cat package.json(orpyproject.toml), detect stack, list features, check existingREADME.md,.github/docs. - Generate — Hero: one-line SEO description + 4 badges (license, build, version, stars) + optional SVG logo (light/dark GitHub themes). Quick Start: zero-config, copy-paste runnable. Sections: Features table, Project Structure, Key Features, Development Workflow, Testing, Contributing, License.
- Audit — Before finalizing, verify:
- Logo renders both themes
- Badges URLs valid
- Quick Start works with zero API keys
- Code blocks have language specifier
- TOC anchors match headings, internal links exist
- Description matches GitHub repo "About" field
- Install commands cover every interface
Verification
- README has hero + 4 badges + Quick Start in first viewport
- Badges valid, logo renders both themes
- Quick Start copy-paste runnable, all code blocks have language tag
- TOC anchors and internal links valid, description matches About
References
- Source:
d-o-hub/github-template-ai-agentsreadme-best-practices,github/awesome-copilotreadme-blueprint-generator
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
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.