← Back to Skills Marketplace
sunshine-del-ux

GitHub README Generator

by Sunshine-del-ux · GitHub ↗ · v1.0.0
cross-platform ⚠ suspicious
464
Downloads
0
Stars
4
Active Installs
1
Versions
Install in OpenClaw
/install github-readme-generator
Description
Generate beautiful, professional GitHub README files for your projects. Supports multiple templates, languages, and customization options.
README (SKILL.md)

k97et5jhv7rb8769f2fnr80eg1824c8f

Usage Guidance
This skill appears to do what it says: it runs a local shell script that writes README.md from templates and may read your local .git user.name. Before installing/running: (1) review the included github-readme-generator.sh (you already have it) and ensure you trust the author, (2) run it in a safe directory because it will overwrite README.md, (3) be aware the script uses simple sed substitutions that may behave oddly if your project name or description contain unusual characters (slashes, braces), and (4) no credentials or network calls are requested by the skill, so there is low risk of secret exfiltration. If you want extra safety, run the script in a disposable repo or review/modify it to sanitize inputs before use.
Capability Analysis
Type: OpenClaw Skill Name: github-readme-generator Version: 1.0.0 The `github-readme-generator.sh` script is vulnerable to `sed` injection. User-provided inputs for `NAME` and `DESCRIPTION` are directly used in `sed` replacement commands without proper escaping of special characters (e.g., `/`, `&`). This allows an attacker to craft inputs that can corrupt the generated `README.md` file or inject arbitrary markdown/text, which could potentially be used for prompt injection if the `README.md` is later processed by an AI agent. This is a significant input sanitization vulnerability.
Capability Assessment
Purpose & Capability
Name/description match the provided assets: SKILL.md documents a README generator and the repository includes a .sh script that generates README.md from templates and inputs. No unrelated credentials, binaries, or external services are requested.
Instruction Scope
Runtime instructions are limited to generating README content and invoking the included shell script. The script only reads .git/user.name (if present) to populate author name and writes README.md in the current directory. It does not send data to external endpoints or read unrelated system files. Note: placeholder replacement uses sed with unescaped user input, which can mis-handle certain characters (e.g., slashes) — a robustness issue, not evidence of malicious scope creep.
Install Mechanism
No install spec or remote downloads; the skill is instruction-only with an included shell script. Nothing is fetched from external URLs or installed automatically.
Credentials
No required environment variables or credentials. The script optionally respects AUTHOR_NAME if set and reads git config user.name locally; both are reasonable and proportional to the stated purpose.
Persistence & Privilege
Skill does not request persistent presence (always is false), does not modify other skills or system-wide agent settings, and performs only local file output (README.md).
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install github-readme-generator
  3. After installation, invoke the skill by name or use /github-readme-generator
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of github-readme-generator. - Generate professional GitHub README files with multiple templates. - Supports English, Chinese, Japanese, Spanish, and Korean. - Auto-detects project type and generates suitable sections and badges. - Includes customizable options for template, language, table of contents, and output path. - No dependencies required; uses built-in templates.
Metadata
Slug github-readme-generator
Version 1.0.0
License
All-time Installs 4
Active Installs 4
Total Versions 1
Frequently Asked Questions

What is GitHub README Generator?

Generate beautiful, professional GitHub README files for your projects. Supports multiple templates, languages, and customization options. It is an AI Agent Skill for Claude Code / OpenClaw, with 464 downloads so far.

How do I install GitHub README Generator?

Run "/install github-readme-generator" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is GitHub README Generator free?

Yes, GitHub README Generator is completely free (open-source). You can download, install and use it at no cost.

Which platforms does GitHub README Generator support?

GitHub README Generator is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created GitHub README Generator?

It is built and maintained by Sunshine-del-ux (@sunshine-del-ux); the current version is v1.0.0.

💬 Comments