# readme-generator

> 技能工具 - 专业的技能工具

- Author: sanwenjing
- Repository: sanwenjing/opencode
- Version: 20260204091223
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-06
- Source: https://github.com/sanwenjing/opencode
- Web: https://mule.run/skillshub/@@sanwenjing/opencode~readme-generator:20260204091223

---

---
name: readme-generator
description: "技能工具 - 专业的技能工具"
license: 专有。LICENSE.txt 包含完整条款
---

---
name: readme-generator
description: "---
name: readme-generator
description: Generate professional README.md files for projects
license: 完整条款见 LICENSE.txt
---

 What I do
- Analyze project structure and dependencies to understand the codebase
- Generate comprehensive README.md with proper sections
- Include installation instructions, usage examples, and API documentation
- Add badges, contributing guidelines, and license information
- Format content following GitHub README best practices

 When to use me
Use this when you need to:
- Create a new README for an existing project
- Update an outdated README with current project information
- Generate documentation for a new repository
- Standardize README format across multiple projects

 How I work
1. Examine project files (package.json, source code, config files)
2. Identify project type, framework, and main features
3. Generate appropriate sections based on project characteristics
4. Include interactive examples and code snippets when possible
5. Suggest relevant badges and links for enhanced visibility

 Sections I typically include
- Project title and description
- Installation instructions
- Usage examples
- API documentation (if applicable)
- Contributing guidelines
- License information
- Related projects or acknowledgments - 专业的技能工具，用于..."
license: 专有。LICENSE.txt 包含完整条款
---

---
name: readme-generator
description: Generate professional README.md files for projects
license: 完整条款见 LICENSE.txt
---

## What I do
- Analyze project structure and dependencies to understand the codebase
- Generate comprehensive README.md with proper sections
- Include installation instructions, usage examples, and API documentation
- Add badges, contributing guidelines, and license information
- Format content following GitHub README best practices

## When to use me
Use this when you need to:
- Create a new README for an existing project
- Update an outdated README with current project information
- Generate documentation for a new repository
- Standardize README format across multiple projects

## How I work
1. Examine project files (package.json, source code, config files)
2. Identify project type, framework, and main features
3. Generate appropriate sections based on project characteristics
4. Include interactive examples and code snippets when possible
5. Suggest relevant badges and links for enhanced visibility

## Sections I typically include
- Project title and description
- Installation instructions
- Usage examples
- API documentation (if applicable)
- Contributing guidelines
- License information
- Related projects or acknowledgments