What I do
I create high-quality README files that communicate project value and help users get started quickly. Based on proven patterns from successful open source projects, I provide:
- •Templates for different project types (CLI tools, libraries, web apps, AI/ML tools)
- •Style guidelines for scannable, compelling documentation
- •Content checklists to ensure completeness
- •Badges and visual elements selection guidance
Included Resources
This skill includes references/README-GUIDE.md with:
- •Project-type templates (headers, sections, examples)
- •Writing style and visual guidelines
- •Content checklists
- •Common pitfalls to avoid
When to use me
- •Create a README for a new project
- •Improve an existing README
- •Learn README best practices
- •Prepare a project for open source release
How I work
- •Analyze project - type, language, framework, existing structure
- •Select sections - appropriate template based on project type
- •Add badges - CI/CD, code quality, package, social
- •Include supplementary - Contributing, Code of Conduct, Security, Changelog, License
Output format
I create a README.md with:
- •Markdown syntax with proper heading hierarchy
- •Code blocks with language annotations
- •Relative links to local resources
- •Standard badge sizes
Example
markdown
# Project Name Brief description (one line, under 80 characters) [](link) [](link) [](link) ## Features - Feature 1 with brief description - Feature 2 with brief description ## Getting Started ### Prerequisites - Node.js 18+ - npm or yarn ### Installation ```bash npm install project-name
Documentation
See docs/ for detailed guides.
Contributing
Contributions welcome! See CONTRIBUTING.md.
License
MIT License - see LICENSE
code