Readme Gen — Security skill for Claude Code

AI README Generator Skill

Create, audit, and improve professional GitHub READMEs with an AI agent that verifies every claim against the repository.

`readme-gen` is a repository-aware documentation skill for Codex, Claude Code, and other tools that support the [Agent Skills format](https://agentskills.io/home). It detects the project type and documented technology stack, then produces accurate GitHub-flavored Markdown with practical setup instructions, badges, Mermaid architecture diagrams, testing guidance, and deployment details when the repository supports them.

**Repository truth > technical clarity > visual polish > marketing.**

What it does

• Creates a complete README for applications, libraries, CLIs, APIs, monorepos, frameworks, and smaller projects.
• Audits existing documentation against source code, manifests, configuration, tests, CI, and deployment files.
• Redesigns or updates a README without discarding accurate project identity, credits, warnings, or caveats.
• Adds evidence-backed technology badges, Mermaid diagrams, setup steps, testing instructions, and deployment guidance.
• Works with Codex, Claude Code, and other Agent Skills-compatible coding agents.

Installation

Quick install (recommended)

With Node.js/npm and Git available, run this from the project you want to document:

npx skills add normieg/Readme-gen --skill readme-gen

Choose your agent in the installer. It downloads the skill and sets up the appropriate agent directory; no manual clone or copy is needed. The [Skills CLI](https://github.com/vercel-labs/skills#install-a-skill) supports Claude Code, Codex and other agents.

To install for both Claude Code and Codex across all your projects:

npx skills add normieg/Readme-gen --skill readme-gen --agent claude-code codex --global

Omit `--global` for a project-only installation. To preview the available skill without installing it:

npx skills add normieg/Readme-gen --skill readme-gen --li