Skip to content

dexter826/readme-generator

v1.0.1MIT

Generate or update evidence-grounded README.md files for any repository, in English or Vietnamese, with anti-leakage guardrails.

Cross-platform AgentSkill for generating and updating evidence-grounded README.md documentation across software repositories.

🎬 Watch the demo video

Capabilities

  • Codebase-first discovery: Extracts verified runtimes, dependencies, entrypoints, scripts, environment variable names, licenses, and local visual assets from real repository files.
  • Adaptive clarification gate: Consolidates ambiguous choices (output language, repository visibility, missing critical metadata, or existing-file strategy) into one concise question turn before editing.
  • Adaptive archetype composition: Supports web/mobile/desktop applications, backend APIs, libraries/SDKs, CLI tools, monorepos, plugins/agent skills, and hybrid repositories without forcing fixed line caps.
  • Anti-leakage guardrails: Excludes live credentials, database security rules, raw internal schema dumps, CI/CD workflow internals, and private endpoints.
  • Bilingual output standards: Supports technical English and natural Vietnamese with complete diacritics and anti-translationese rules.

Execution Modes & Compatibility

Compatible with AgentSkills-enabled coding agents without IDE-locked tool constraints: Antigravity, Claude Code, Codex, and Gemini CLI.

ModeWhen appliedBehavior
CreateNo README.md exists yetComposes sections from verified codebase evidence and matching blueprints
Replace cleanlyExisting starter boilerplate or stale docRebuilds structure from current repo facts while keeping valid local media
Preserve-and-upgradeExisting custom README.mdKeeps valid custom sections, badges, and media while updating stale facts
Surgical updateTargeted section change requestedModifies only specified outdated or broken sections

Installation

Via Plugin Marketplace (Claude Code, Codex, Antigravity)

Install the repository directly as a plugin:

Claude Code:

/plugin marketplace add dexter826/readme-generator
/plugin install readme-generator@readme-generator

Codex:

codex plugin marketplace add dexter826/readme-generator
codex plugin add readme-generator@readme-generator

Antigravity:

agy plugin install https://github.com/dexter826/readme-generator

Via Skills CLI (Recommended)

Install directly from GitHub using skills.

Project-level installation:

npx skills add dexter826/readme-generator

Global installation (non-interactive):

npx skills add dexter826/readme-generator -g -y

Manual Installation

Copy only the skills/readme-generator directory into your agent's skills directory so root repository files are not included.

Global on Unix/macOS (~/.agents/skills):

tmp=$(mktemp -d) && git clone --depth 1 https://github.com/dexter826/readme-generator.git "$tmp" && mkdir -p ~/.agents/skills && rm -rf ~/.agents/skills/readme-generator && cp -R "$tmp/skills/readme-generator" ~/.agents/skills/readme-generator && rm -rf "$tmp"

Project-level on Unix/macOS (.agents/skills):

tmp=$(mktemp -d) && git clone --depth 1 https://github.com/dexter826/readme-generator.git "$tmp" && mkdir -p .agents/skills && rm -rf .agents/skills/readme-generator && cp -R "$tmp/skills/readme-generator" .agents/skills/readme-generator && rm -rf "$tmp"

Global on Windows PowerShell ($HOME\.agents\skills):

$tmp = Join-Path ([IO.Path]::GetTempPath()) ([IO.Path]::GetRandomFileName())
git clone --depth 1 https://github.com/dexter826/readme-generator.git $tmp
if ($LASTEXITCODE -eq 0) {
  New-Item -ItemType Directory -Force -Path "$HOME\.agents\skills" | Out-Null
  Remove-Item -Recurse -Force -ErrorAction SilentlyContinue "$HOME\.agents\skills\readme-generator"
  Copy-Item -Recurse "$tmp\skills\readme-generator" "$HOME\.agents\skills\readme-generator"
}
Remove-Item -Recurse -Force -ErrorAction SilentlyContinue $tmp

Usage

Ask your agent to document a repository or invoke /readme-generator when supported. When a repository already contains a README.md or lacks key setup details (such as a LICENSE, production command, or .env.example), the skill asks once how to proceed before modifying files.

Example Prompts

Create a README.md for this repository
Update README.md to match the current FastAPI endpoints and Docker setup
Viết file README.md bằng tiếng Việt cho repo này

Repository Structure

readme-generator/
├── README.md                     # Overview, install, and usage
├── CHANGELOG.md                  # Release history
├── LICENSE                       # MIT
├── .editorconfig                 # Editor defaults
├── .gitattributes                # Line endings and binary types
├── .gitignore                    # Ignored local files
├── plugin.json                   # Codex manifest
├── .claude-plugin/               # Claude Code manifest and marketplace
├── .antigravity-plugin/          # Antigravity manifest
├── .agents/plugins/              # Codex marketplace
├── docs/
│   └── logo/                     # M.O.B Signal logo assets
├── skills/readme-generator/
│   ├── SKILL.md                  # Workflow and rules
│   ├── references/               # Archetypes, style, and anti-leakage guidance
│   └── assets/blueprints/        # App, library, CLI, monorepo, and plugin blueprints
└── evals/
    └── evals.json                # Evaluation prompts and assertions

License

Distributed under the MIT license.