crafting-effective-readmes
Guides agents in creating, updating, and reviewing effective READMEs tailored to specific project types and audiences.
Install
npx skills add https://github.com/softaworks/agent-toolkit --skill crafting-effective-readmesStats
| Total installs | 3,486 |
| Weekly installs | 572 |
| GitHub stars | 1.2K |
| First seen | Jan 20, 2026 |
| Source | @softaworks/agent-toolkit |
Summary
- Identifies four project types (Open Source, Personal, Internal, Config) with distinct audience needs and required sections
- Provides a structured three-step process: identify the task (creating, adding, updating, or reviewing), ask task-specific questions, then solicit final feedback
- Includes essential baseline sections for all READMEs: name, description, and usage with examples
- References supporting materials covering section checklists by project type, common prose mistakes, and deeper reference guidance
Tags
Related skills
| Skill | Installs | vs crafting-effective-readmes |
|---|---|---|
| wcag-audit-patterns | 3,809 | +323 |
| workflow-patterns | 3,508 | +22 |
| track-management | 3,303 | -183 |
| postmortem-writing | 3,405 | -81 |
| python-type-safety | 3,373 | -113 |
FAQ
- How many installs does crafting-effective-readmes have?
- crafting-effective-readmes has 3,486 total installs and 572 installs this week.
- Where is crafting-effective-readmes hosted?
- crafting-effective-readmes is published by @softaworks/agent-toolkit at https://github.com/softaworks/agent-toolkit.
- How many GitHub stars does crafting-effective-readmes have?
- crafting-effective-readmes has 1.2K GitHub stars.
- When was crafting-effective-readmes first indexed?
- OrangeBot.AI first indexed crafting-effective-readmes on Jan 20, 2026.
- How do I install crafting-effective-readmes?
- Run: npx skills add https://github.com/softaworks/agent-toolkit --skill crafting-effective-readmes