cli-forge-readme
CommunityGenerate professional README.md files for your projects.
Software Engineering#project documentation#codebase documentation#README.md#README generator#project landing page
AuthorDestynova2
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the challenge of creating comprehensive and professional README.md files for various types of projects, ensuring clarity and ease of use for users.
Core Features & Use Cases
- Project-Specific READMEs: Automatically generates READMEs tailored to the project type, such as libraries, CLI tools, infrastructure, and backend apps.
- Language Detection: Detects the primary language of the project and generates READMEs accordingly.
- 3-Tier Pyramid Structure: Organizes content into a clear, structured format: Hook, Get Started, and Contribute & Understand.
- Formatting Standards: Adheres to specific formatting rules for headings, code blocks, links, and visual elements.
- Quality Scoring: Evaluates the completeness of the README using the README Completeness Index (RCI).
Quick Start
Run the command /cli-forge-readme [project-path] to generate a README for your project.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 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: cli-forge-readme Download link: https://github.com/Destynova2/cli-code-skills/archive/main.zip#cli-forge-readme 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 620,000+ vetted skills library on demand.