GitHub README Generator

Generate beautiful, professional GitHub README files for your projects. Supports multiple templates, languages, and customization options.

Security Scan

The skill's files and runtime instructions are coherent with its stated purpose: a local README generator script that writes README.md and reads minimal local metadata (git user.name) but does not request credentials or network access.

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).

Assessment

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.

Generate professional GitHub README files for your projects with multiple templates and customization options.

Features

• 🎨 Multiple templates (Modern, Minimal, Detailed, API-focused)
• 🌐 Multi-language support
• 📋 Auto-generated badges
• 💼 Project type detection (Library, CLI, Web App, etc.)
• 📊 Auto-generated stats sections

Usage

Basic Generation

# Generate with default template
github-readme-generator "Project Name" "Description"

# Specify template
github-readme-generator "Project Name" "Description" --template modern

# Specify language
github-readme-generator "项目名称" "描述" --lang zh

Available Templates

Template	Use Case
modern	Most projects (default)
minimal	Simple libraries
detailed	Complex projects with full documentation
api	API/REST services
cli	Command-line tools

Options

• --template, -t : Template name
• --lang, -l : Language (en, zh, ja, es, ko)
• --badges, -b : Include badge section (default: true)
• --toc, -c : Include table of contents (default: false)
• --output, -o : Output file path

Examples

Python Library

github-readme-generator "my-lib" "A powerful Python library" --template modern

CLI Tool

github-readme-generator "super-cli" "Amazing CLI tool" --template cli

Node.js Package

github-readme-generator "my-package" "NPM package description" --template modern

Installation

# No dependencies required
# Uses built-in templates

How It Works

1. Detects project type from name/description
2. Selects appropriate template
3. Generates sections based on project type
4. Adds relevant badges
5. Outputs ready-to-use README.md

Output Example

The generated README includes:

• Project title and badges
• Description
• Features list
• Installation instructions
• Usage examples
• API reference (if applicable)
• Contributing guidelines
• License
• Contact information