readme-generator — Claude Code plugin: what it does, how to install
readme-generator — a Claude Code plugin that analyzes a project to generate a README file. Useful when preparing repository documentation.
Apache-2.0 ★ 2,858 updated 2026-05-12
/plugin marketplace add rohitg00/awesome-claude-code-toolkit
/plugin install readme-generator@claude-code-toolkitWhat readme-generator does
This plugin analyzes project files and writes a README based on the codebase. It inspects what the project contains to build documentation without manual drafting.
Installation requires registering the rohitg00/awesome-claude-code-toolkit marketplace first. Without adding that catalog to Claude Code, the command to install readme-generator@claude-code-toolkit fails. The project is distributed under the Apache-2.0 license.
What it helps with
- generate a README from project analysis
- document the codebase structure
- produce a repository description based on existing files
Example prompts for the agent
- Analyze this project and generate a README for it.
- Create a README file based on the current repository structure.
How to install readme-generator
Plugin marketplace
/plugin marketplace add rohitg00/awesome-claude-code-toolkit/plugin install readme-generator@claude-code-toolkitStep by step, with commands for each platform: Claude Code plugins: marketplaces, installing, and building your own
Questions about readme-generator
How to install readme-generator in Claude Code?
Add the toolkit marketplace with /plugin marketplace add rohitg00/awesome-claude-code-toolkit. Then install the plugin using /plugin install readme-generator@claude-code-toolkit.
What does the readme-generator plugin do?
It analyzes the project codebase and writes a README file describing the repository.
What license does readme-generator use?
The plugin is licensed under Apache-2.0 within the rohitg00/awesome-claude-code-toolkit repository.
Source text
readme-generator · Apache-2.0
Smart README generation from project analysis
© rohitg00 · Apache-2.0 · rohitg00/awesome-claude-code-toolkit