create-readme
Create comprehensive, well-structured README.md files adapted to the project type. Trigger: When user asks to create README, generate documentation, or initialize project docs.
How do I install this agent skill?
npx skills add https://github.com/vekzz-dev/opencode-skills --skill create-readmeIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill is a documentation assistant designed to generate README.md files. It identifies project technology stacks by inspecting manifest files like package.json and pom.xml using standard read-only commands. No malicious patterns or security vulnerabilities were detected.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
When to Use
- Creating a new README.md file
- User asks to "create README" or "generate documentation"
- Initializing project documentation
- Need help structuring project docs
Instructions
Step 1: Analyze the Project
First, explore the project to understand:
-
Technology Stack: Detect package manager and language
package.json→ Node.js/npm library or apppom.xml/build.gradle→ Java/Maven/Gradlerequirements.txt/setup.py/pyproject.toml→ Pythongo.mod→ GoCargo.toml→ Rustcomposer.json→ PHP
-
Framework: Detect specific frameworks
spring-bootin pom.xml → Spring Bootreact,vue,angularin package.json → Frontend frameworkfastapi,django,flaskin requirements.txt → Python webexpressin package.json → Express.jsnext,nuxt,astroin package.json → Meta-frameworks
-
Project Purpose: Quick Start, library, CLI tool, web app, etc.
Step 2: Select Template
Use the appropriate reference based on project type:
| Project Type | Reference |
|---|---|
| npm/pip/maven library | references/sections/library.md |
| CLI tool | references/sections/cli-tool.md |
| Web application | references/sections/webapp.md |
| Python project | references/sections/python.md |
| Java project | references/sections/java.md |
| Go project | references/sections/go.md |
| Rust project | references/sections/rust.md |
| Ruby / Rails project | references/sections/ruby.md |
| .NET / C# project | references/sections/dotnet.md |
| Docker project | references/sections/docker.md |
Step 3: Generate README
Follow these rules:
- Be concise - Don't write lengthy prose, use structure
- Working code - All examples must work, no pseudocode
- GFM + Admonitions - Use GitHub Flavored Markdown and
> [!NOTE],> [!WARNING], etc. - Minimal emojis - Use sparingly for visual hierarchy
- Table of Contents - For READMEs longer than ~50 lines
- No redundant sections - Skip LICENSE, CONTRIBUTING, CHANGELOG (separate files)
Step 4: Add Badges
Include relevant badges from references/badges.md:
- Package version
- Build/CI status
- License
- Language stats
- Downloads
Step 5: Include Examples
Reference references/examples/ for working examples:
- library_example.md - npm/pip libraries
- cli_example.md - CLI tools
- webapp_example.md - Web applications
Commands
# Detect project type
ls -la | grep -E "package.json|pom.xml|build.gradle|requirements.txt|go.mod|Cargo.toml"
# Check package.json for Node.js project
cat package.json | grep -E '"name"|"version"|"description"|"main"|"bin"'
# Check pom.xml for Java project
cat pom.xml | grep -E '<artifactId>|<version>|<description>'
# Check go.mod for Go project
cat go.mod | head -5
# Check Cargo.toml for Rust project
cat Cargo.toml | grep -E '\[package\]|name|version|description'
README Structure
Required Sections
# <project-name>
One-line description of what the project does.
## Installation
Quick installation command
## Usage
Minimal working example
## License
One line
Optional Sections (include as needed)
- Badges - At top, below title
- Table of Contents - If > 50 lines
- Features - Key capabilities
- Requirements - Prerequisites
- Configuration - Setup options
- API Reference - For libraries
- Contributing - Short reference (link to CONTRIBUTING.md)
- Acknowledgments - Third-party credits
Examples Template
Library
# my-lib
A brief description of what this library does.
[![npm version][npm-badge]][npm-url]
## Installation
```bash
npm install my-lib
Usage
import { myFunction } from 'my-lib';
const result = myFunction('input');
console.log(result);
API
| Function | Description | Returns |
|---|---|---|
myFunction(input) | Does something | string |
License
MIT - see LICENSE
### CLI Tool
```markdown
# my-cli
A brief description of what this CLI tool does.
[![npm version][npm-badge]][npm-url]
## Installation
```bash
npm install -g my-cli
Usage
my-cli --help
my-cli command --option value
Commands
| Command | Description |
|---|---|
my-cli init | Initialize project |
my-cli build | Build the project |
License
MIT - see LICENSE
### Web Application
```markdown
# my-app
A brief description of this web application.
[![Build status][build-badge]][build-url]
## Features
- Feature 1
- Feature 2
- Feature 3
## Quick Start
```bash
npm install
npm run dev
Deployment
Deployment instructions...
License
MIT - see LICENSE
## Key Principles
1. **Answer the 4 questions in 60 seconds:**
- What does this do?
- How do I install it?
- How do I use it?
- Should I trust it?
2. **Show working code first** - Don't explain before showing
3. **Use tables** - For API, options, commands
4. **Keep it updated** - Outdated READMEs lose trust
5. **Be helpful** - Think like a new user, not the maintainer
## Resources
- [Project Types Detection](references/project-types.md)
- [Section Templates](references/sections/)
- [Examples](references/examples/)
- [Badges](references/badges.md)
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/vekzz-dev/opencode-skills/create-readme">View create-readme on skillZs</a>