Menu
Auto-generate concise, visually stunning README.md with project auto-scanning, badges, and 3 style modes.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | readme-generator |
| description | Auto-generate concise, visually stunning README.md with project auto-scanning, badges, and 3 style modes. |
Generate concise, scannable README files that look premium on GitHub. Auto-detects project context and generates badges, features, and install instructions.
package.json, setup.py, VERSION, .agent/ to fill real data# Scan project and generate README
python .agent/skills/readme-generator/scripts/readme_gen.py --path .
# With specific style
python .agent/skills/readme-generator/scripts/readme_gen.py --path . --style minimal
python .agent/skills/readme-generator/scripts/readme_gen.py --path . --style standard # default
python .agent/skills/readme-generator/scripts/readme_gen.py --path . --style detailed
python .agent/skills/readme-generator/scripts/readme_gen.py \
--path . \
--name "My Project" \
--slogan "One line that sells" \
--author "username" \
--image "https://example.com/banner.png"
| Mode | Lines | Best For |
|---|---|---|
minimal | ~40-60 | Libraries, packages, simple tools |
standard | ~80-120 | Most projects (default) |
detailed | ~120-180 | Complex frameworks, multi-component projects |
| Source | Extracts |
|---|---|
package.json | Name, version, license, scripts, dependencies |
setup.py / pyproject.toml | Name, version, license, dependencies |
VERSION | Version number |
LICENSE | License type |
.agent/skills/ | Skill count |
.agent/workflows/ | Workflow/agent count |
Dockerfile | Docker support |
tsconfig.json | TypeScript detection |
<div align="center"> with title + badges + image| Emoji Feature | One-line description |Generate unit/integration tests with smart edge case analysis (Zero Token Skeleton + Smart Mode).
Persistent team profiles — carry your coding style, rules, and bug-fix knowledge across projects. 3-tier memory (Hot/Warm/Cold) with TF-IDF search.
Deploy local websites to the internet instantly via Cloudflare Tunnel. Zero hosting, zero domain needed.
Suggests suitable tech stack based on project requirements using local database.
Analyzes market trends, hot features, and user expectations.
Creative idea advisor. Brainstorm frameworks, product archetypes, industry data, and monetization models. Zero-token data retrieval via script.