README Patterns
CommunityCraft effective READMEs in seconds.
Software Engineering#documentation#markdown#project structure#technical writing#developer experience#readme
AuthorHermeticOrmus
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill helps developers create clear, concise, and effective README files that quickly communicate a project's purpose and guide users effectively.
Core Features & Use Cases
- 5-Second Test Guidance: Ensures your project's core value proposition is immediately understandable.
- README Pyramid Structure: Organizes content for different reader attention spans.
- Badge Selection Best Practices: Recommends essential and optional badges for project credibility.
- Install & Quick Start Patterns: Provides templates for easy user onboarding.
- Project Type Specific Orders: Offers tailored README structures for libraries, CLIs, and services.
- Anti-Pattern Identification: Highlights common mistakes to avoid in READMEs.
Quick Start
Use the README Patterns skill to generate a README structure for a new Python CLI tool.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: README Patterns Download link: https://github.com/HermeticOrmus/LibreCopy-Claude-Code/archive/main.zip#readme-patterns Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.