Skip to main content
plugin

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

Install into Claude Code · Plugin marketplace All methods and platforms ↓
/plugin marketplace add softaworks/agent-toolkit
/plugin install crafting-effective-readmes@agent-toolkit
Open on GitHub

What 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.md and 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-toolkit

Step 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

Similar plugins

All plugins for Writing and docs →

From the same set79

The whole set →
marp-slide marp-slide generates Marp presentation slides and supplies 7 ready-made themes. Runs whenever you ask Claude Code to build slide decks or Marp documents. ★ 2,707repo stars frontend-to-backend-requirements frontend-to-backend-requirements — a Claude Code plugin that extracts frontend data needs and formats them for backend developers. Use it when you need to pass a list of endpoints, data structures or request parameters. ★ 2,707repo stars excalidraw Plugin for working with Excalidraw files in Claude Code. Visualize system architecture, flowcharts, and diagrams without leaving the IDE. ★ 2,707repo stars draw-io Builds, edits, and reviews draw.io diagrams inside Claude Code. Useful for modifying raw XML layouts, adding AWS icons, and converting to PNG. ★ 2,707repo stars c4-architecture c4-architecture — a Claude Code plugin that generates architecture diagrams in C4 notation as Mermaid graphs. Use it to visualize system structure, document components, and show how parts interact. ★ 2,707repo stars backend-to-frontend-handoff-docs backend-to-frontend-handoff-docs creates API handoff documentation for frontend teams once backend development is finished. ★ 2,707repo stars skill-judge skill-judge — a Claude Code plugin that evaluates Agent Skills against official specifications and best practices. Use it to review SKILL.md files and skill packages, catching structural and formatting issues before publication. ★ 2,707repo stars plugin-forge plugin-forge — a Claude Code plugin that streamlines plugin creation and management, handling structure, manifests, and marketplace integration. Automates work with plugin.json, component setup, and version bumps. ★ 2,707repo stars

Project sponsors

Companies that keep this analytics open