360 Secure SkillHub
360 安全技能中心

readme-gen

该 Skill 用于扫描项目结构,检查 package.json、.gitignore、LICENSE、tests/ 和 docs/,检测语言并统计文件数量,然后按模板生成包含 Features、Install、Usage、Structure 和 License 的 README.md;还建议添加徽章、截图和贡献指南。材料未提供实际扫描脚本或校验流程。

vexify-build
vexify-build
热度 13.04
最近更新 2026-10-04 21:33:43
分类:开发依赖:读写文件应用场景:模板 / 文案创作 / 摘要总结

安装技能

复制下面的话术发给你的 Agent,它会通过 secure-skills 检索并安装该技能。

执行命令安装此 skill: npx secure-skills-cli add readme-gen
Metadata
name
readme-gen
description
Use when user wants to generate a README.md for their project.
triggers
["readme","README","生成说明","项目文档"]
version
1.0.0
author
VBot

README Generator

Generate a polished README.md from project structure

Scan Project

  1. Check package.json for name, description, scripts
  2. Check for: .gitignore, LICENSE, tests/, docs/
  3. Detect language from file extensions
  4. Count total files and lines

Output Template

# {project-name}

{description}

## Features

- Feature 1
- Feature 2

## Install

\`\`\`bash
npm install
\`\`\`

## Usage

\`\`\`bash
npm start
\`\`\`

## Structure

\`\`\`
{file-tree}
\`\`\`

## License

MIT

Tips

  • Use shields.io for badges
  • Include demo/screenshots if available
  • Add contribution guidelines if complex