360 Secure SkillHub
360 安全技能中心

Readme Template

通过 bash 脚本按 standard、awesome、minimal、detailed、library、app、api、badges 等风格输出含占位符的 Markdown README 模板,需用户自行补全项目细节并保存为 README.md。

xueyetianya
xueyetianya
热度 57.68
最近更新 2026-05-11 17:30:20
分类:效率依赖:代码执行应用场景:模板

安装技能

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

执行命令安装此 skill: npx secure-skills-cli add readme-template
Metadata
version
2.0.0
name
README Template
description
README template generator. Standard, awesome-list, minimal, detailed, library, app, API project.
author
BytesAgain
homepage
https://bytesagain.com
source
https://github.com/bytesagain/ai-skills

README Template — Professional README Generator

Pick a style, get a polished README. Every project deserves one.

Available Templates

Command Style Best For
standard Balanced sections Most projects
awesome Awesome-list format Curated resource lists
minimal Bare essentials Small scripts/tools
detailed complete Enterprise / complex projects
library API-focused npm/pip packages
app User-facing Desktop/mobile/web apps
api Endpoint-centric REST/GraphQL services
badges Shield.io badges Any project (add-on)

Usage

bash scripts/readme-template.sh standard myproject
bash scripts/readme-template.sh minimal mytool
bash scripts/readme-template.sh badges myproject npm
bash scripts/readme-template.sh awesome "DevOps Tools"

Output

All templates output valid Markdown, ready to save as README.md. Includes placeholder sections — fill in your details and ship.

💬 Feedback & Feature Requests: https://bytesagain.com/feedback Powered by BytesAgain | bytesagain.com