Skip to main content
skill CX Codex

make-readme — Claude Code skill: what it does, how to install

make-readme inspects repository context, runs a brief questionnaire, and builds a complete README.md with status badges.

no license ★ 276 updated 2026-10-29

Install into Claude Code · Plugin marketplace All methods and platforms ↓
/plugin marketplace add gupsammy/Claudest
/plugin install claude-coding@Claudest
Open on GitHub

What make-readme does

The skill inspects local manifests before writing any docs. It looks for package.json, pyproject.toml, Cargo.toml, or go.mod to fill in default titles and primary runtimes. If it finds three or more plugin manifests in subfolders, it flags the repository as a plugin collection.

Next, the agent conducts a structured interview. You select the target architecture, runtime, license, and depth. Minimal builds skip straight to formatting. Standard and comprehensive setups trigger extra questions about screenshots, roadmap lists, and badge collections.

Existing files are safe because the skill warns before replacing any current README.md. It outputs ready-to-use markdown with custom header alignments and navigation links.

What it helps with

  • generate structured README.md files from repository metadata
  • embed shields.io badges into documentation headers
  • catalog plugins in monorepos with component directories
  • scaffold contributing guidelines and configuration tables

Example prompts for the agent

  • Create a README for my project
  • Generate standard project documentation with badges
  • Set up project docs for this plugin collection

How to install make-readme

1Plugin marketplace

/plugin marketplace add gupsammy/Claudest
/plugin install claude-coding@Claudest

This installs the whole claude-coding plugin with all its skills

2Skills CLI (Vercel)

npx skills add gupsammy/Claudest --skill make-readme -a claude-code

3Manually: put the files in place

~/.claude/skills/make-readme/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/make-readme/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about make-readme

How to install make-readme in Claude Code?

Add the marketplace by running /plugin marketplace add gupsammy/Claudest, then install the package with /plugin install claude-coding@Claudest.

What does make-readme do?

It scans repository manifests, asks about sections and styles, and writes a complete README.md file.

Can make-readme overwrite my existing file?

It checks your directory first and prompts for confirmation if a README.md is already present.

Similar skills

All skills for Writing and docs →

From the same set47

The whole set →
update-readme update-readme rewrites an existing README.md using the current code, git log and changelog. Useful once the docs drift away from what the repo actually does. CX Codex +1 ★ 276repo stars architecture-auditor architecture-auditor reviews system structure, detects circular dependencies, and suggests design patterns when features touch multiple modules. CX Codex ★ 276repo stars make-changelog make-changelog creates or updates CHANGELOG.md from Git history in Keep a Changelog format. Use it when preparing release notes or catching up on missing entries. CX Codex +1 ★ 276repo stars recall-conversations recall-conversations reads back your earlier Claude sessions: finds a decision, restores context, or builds a retro from the local conversation database. CX Codex +1 ★ 276repo stars push-pr push-pr is a Claude Code skill that pushes a branch and creates or updates its GitHub pull request. For large or mixed changes, it can propose splitting them into stacked PRs. CX Codex +1 ★ 276repo stars brainstorm brainstorm — an interview skill that turns the tables: the agent asks, you answer, and the session ends with a written spec or decision doc. CX Codex +1 ★ 276repo stars get-token-insights get-token-insights parses Claude Code conversation history, flags token waste, and generates an offline dashboard covering costs, hooks, and agent workflows. CX Codex +1 ★ 276repo stars extract-frames extract-frames detects shot boundaries in a video and saves the first or last frame of each shot. Use it to review an edit or collect frames from selected shots. CX Codex +1 ★ 276repo stars

Project sponsors

Companies that keep this analytics open