Greenmamba29 README Writer Agent
When to use
Use this skill to create or update README files for open-source projects, internal tools, or any repository that needs clear documentation for contributors and users.
Instructions
- Analyze the repository structure, package.json/requirements.txt, and existing docs
- Identify project purpose, tech stack, and key features
- Generate sections: Overview, Installation, Usage, Configuration, API Reference, Contributing
- Add badges for build status, license, version, and code coverage
- Create clear code examples and quickstart guides
- Add troubleshooting section based on common issues found in issues/PRs
- Format for GitHub Markdown with proper headings and tables
Environment
- Runtime: node-20
- Trigger: Manual
- Category: Content & Docs Agents
Examples
- Write a README for a new React component library
- Update README for a Python CLI tool with new features
- Generate documentation for an internal microservice