opensource-readme-generator
CommunityCreate standout READMEs for open-source projects.
Content & Communication#automation#template#documentation#markdown#readme#open-source#readme-guidelines
Authorirahardianto
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the challenge of drafting consistent, high-quality README files for open-source projects, saving time and ensuring clear communication with contributors and users.
Core Features & Use Cases
- Automated README generation: Produces standard sections (About, Installation, Usage, Features, Contributing, License, and Badges) tailored to the project.
- Template-driven quality: Leverages the assets/all-star-readme-template.md and the guidelines in references/readme-guidelines.md to ensure a polished, professional result.
- Project-specific customization: Replaces placeholders (github_username, repo_name, project_title, description, badges) with real project data and sensible defaults, adaptable to various languages and project types.
Quick Start
Run the opensource-readme-generator against your repository to produce a complete README.md using the provided template and guidelines.
Dependency Matrix
Required Modules
None requiredComponents
assetsreferences
💻 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: opensource-readme-generator Download link: https://github.com/irahardianto/monarch/archive/main.zip#opensource-readme-generator 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.