<!-- Generated by scripts/generate-site-content.py — do not edit by hand -->


# claude-plugin-readme

Plugin should have a README.md file

*Formerly known as `plugin-readme`. The legacy name still works in configs, `--rule`/`--skip-rule`, suppression comments, and baselines.*

| | |
|---|---|
| **Severity** | warning (auto) |
| **Autofix** | - |
| **Since** | v0.1.0 |
| **Repo Types** | marketplace, single-plugin |
| **Category** | [Claude Code](claude.md) |

## Why

A README.md in the plugin directory provides human-readable
documentation for users browsing the repository or marketplace.
Without it, users must read the plugin.json and command files to
understand what the plugin does.

## Examples

**Bad:**

```
my-plugin/
  .claude-plugin/
    plugin.json
```

**Good:**

```
my-plugin/
  README.md
  .claude-plugin/
    plugin.json
```

## How to fix

Create a `README.md` file in the plugin's root directory explaining
what the plugin does, how to install it, and how to use its commands.

## Configuration

```yaml
rules:
  claude-plugin-readme:
    enabled: auto  # true | false | auto
    severity: warning
```


*Run `skillsaw explain claude-plugin-readme` to see this documentation and the rule's effective configuration in your terminal.*