crafting-effective-readmes — Claude Code plugin: how to install
crafting-effective-readmes is a Claude Code plugin that generates and refines repository README files, matching templates and sections to the audience and project type.
MIT ★ 2,707 updated 2026-03-05
/plugin marketplace add softaworks/agent-toolkit
/plugin install crafting-effective-readmes@agent-toolkitWhat crafting-effective-readmes does
The plugin bundles the skills/crafting-effective-readmes skill for Claude Code. It directs the assistant to structure project overviews, setup instructions, and usage details according to what readers need.
Instead of a generic markdown template, it adapts sections to the software type. CLI tools get immediate execution snippets, while libraries receive integration guides and API highlights.
Installation relies on the softaworks/agent-toolkit marketplace catalog. Claude Code cannot pull the plugin until that marketplace is registered.
What it helps with
- draft a clear README for a new software repository
- restructure an outdated or messy project overview
- pick documentation sections matching a library or CLI tool
- tailor README instructions to beginners or experienced developers
Example prompts for the agent
- Help me write a solid README for this Python CLI tool
- Review our existing
README.mdand restructure it for external contributors - Draft documentation templates for this open-source library
How to install crafting-effective-readmes
Plugin marketplace
/plugin marketplace add softaworks/agent-toolkit/plugin install crafting-effective-readmes@agent-toolkitStep by step, with commands for each platform: Claude Code plugins: marketplaces, installing, and building your own
Questions about crafting-effective-readmes
How to install crafting-effective-readmes in Claude Code?
Run both marketplace commands in Claude Code: /plugin marketplace add softaworks/agent-toolkit, followed by /plugin install crafting-effective-readmes@agent-toolkit.
What does crafting-effective-readmes do?
It provides guidance and templates for writing repository overviews. The assistant uses it to organize headings, prerequisites, and code examples based on who will read the document.
What is included inside this plugin?
It contains the skills/crafting-effective-readmes skill, which triggers when editing or generating README files.
Source text
crafting-effective-readmes · MIT
Use when writing or improving README files. Provides templates and guidance matched to your audience and project type. Skills: skills/crafting-effective-readmes
© softaworks · MIT · softaworks/agent-toolkit