← 返回 Skills 市场
Readme Template
作者
bytesagain4
· GitHub ↗
· v2.0.0
· MIT-0
437
总下载
0
收藏
1
当前安装
11
版本数
在 OpenClaw 中安装
/install readme-template
功能描述
README template generator. Standard, awesome-list, minimal, detailed, library, app, API project.
安全使用建议
This skill is coherent with its README-generator purpose. Before running: (1) note that scripts/script.sh will create and write files under ~/.local/share/readme-template by default (you can override with README_TEMPLATE_DIR), so review or run it in a sandbox if you prefer; (2) the template generator uses embedded python printing static markdown — it does not call external endpoints or require credentials; (3) if you only want to generate README content, run scripts/readme-template.sh with the desired template argument; (4) as always, inspect scripts you download and avoid running unreviewed code with elevated privileges.
功能分析
Type: OpenClaw Skill
Name: readme-template
Version: 2.0.0
The skill bundle is a README template generator that uses bash and Python to output various Markdown formats. While scripts/readme-template.sh contains a functional bug where it fails to pass command-line arguments to the internal Python logic, the code is transparent and lacks any indicators of malicious intent, data exfiltration, or unauthorized system access. An auxiliary script, scripts/script.sh, is present but appears to be unused boilerplate for local logging.
能力评估
Purpose & Capability
Name/description match the contained scripts. The provided scripts generate README templates (various styles) using embedded Python and a small shell utility; no unrelated services, credentials, or binaries are requested.
Instruction Scope
SKILL.md instructs running scripts/readme-template.sh to produce markdown templates, which is appropriate. The repository also contains scripts/script.sh — a lightweight local utility that creates a data directory (default ~/.local/share/readme-template) and writes logs/data files; this behavior is plausible for a local utility but is not documented in SKILL.md. The scripts do not read system secrets or make network requests; they only write to the user data directory and print output.
Install Mechanism
No install spec or external downloads. The skill is instruction-only with included scripts, so nothing is fetched from untrusted URLs and no archives are extracted.
Credentials
No credentials or required environment variables. The shell utility honors README_TEMPLATE_DIR, XDG_DATA_HOME, and HOME to locate its data directory — standard, expected behavior and proportional to storing local logs/data.
Persistence & Privilege
always:false and normal model invocation. The only persistence is writing into a per-user data directory under ~/.local/share/readme-template (or an overridden README_TEMPLATE_DIR). The skill does not modify other skills or system-wide agent settings.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install readme-template - 安装完成后，直接呼叫该 Skill 的名称或使用
/readme-template触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v2.0.0
v2.5 standard: Use-when desc, homepage, source, security fix
v2.3.4
yaml-fix+quality
v2.3.3
yaml-fix+quality
v2.3.2
Quality upgrade
v2.3.1
Quality upgrade: custom functionality
v2.3.0
Quality fixes: aligned docs with implementation
v2.2.0
Enhanced descriptions for better AI triggering
v1.0.2
Runtime fix
v1.0.1
Add runtime declaration + security compliance
v0.0.1
p
v1.0.0
Initial release of README Template skill.
- Generates professional README files in multiple styles (standard, awesome-list, minimal, detailed, library, app, API).
- Includes command-line usage for each template type.
- Supports badge generation using Shield.io.
- Outputs valid Markdown with placeholder sections for quick project setup.
- Designed with best practices for open-source and developer projects.
元数据
常见问题
Readme Template 是什么？
README template generator. Standard, awesome-list, minimal, detailed, library, app, API project. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 437 次。
如何安装 Readme Template？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install readme-template」即可一键安装，无需额外配置。
Readme Template 是免费的吗？
是的，Readme Template 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
Readme Template 支持哪些平台？
Readme Template 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 Readme Template？
由 bytesagain4（@xueyetianya）开发并维护，当前版本 v2.0.0。
推荐 Skills