← Back to Skills Marketplace
Readme Template
by
bytesagain4
· GitHub ↗
· v2.0.0
· MIT-0
437
Downloads
0
Stars
1
Active Installs
11
Versions
Install in OpenClaw
/install readme-template
Description
README template generator. Standard, awesome-list, minimal, detailed, library, app, API project.
Usage Guidance
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.
Capability Analysis
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.
Capability Assessment
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.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install readme-template - After installation, invoke the skill by name or use
/readme-template - Provide required inputs per the skill's parameter spec and get structured output
Version History
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.
Metadata
Frequently Asked Questions
What is Readme Template?
README template generator. Standard, awesome-list, minimal, detailed, library, app, API project. It is an AI Agent Skill for Claude Code / OpenClaw, with 437 downloads so far.
How do I install Readme Template?
Run "/install readme-template" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Readme Template free?
Yes, Readme Template is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Readme Template support?
Readme Template is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Readme Template?
It is built and maintained by bytesagain4 (@xueyetianya); the current version is v2.0.0.
More Skills