Revert overselling of Claude Code plugin installation

The README was claiming one-command, zero-config installation, but actually requires: 1) marketplace add, 2) plugin install, 3) separate bd CLI installation. This revert tones down the promotional language to match reality.

Thanks to @jjshanks for catching this!
This commit is contained in:
Joshua Shanks
2025-10-15 00:39:53 -07:00
committed by GitHub
parent 3f42cab0d1
commit 3dd3c8f09c

View File

@@ -10,13 +10,6 @@ Drop Beads into any project where you're using a coding agent, and you'll enjoy
Instant start:
**Claude Code users:**
```bash
/plugin marketplace add steveyegge/beads
/plugin install beads
```
**Everyone else:**
```bash
curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/install.sh | bash
```
@@ -102,9 +95,9 @@ paru -S beads-git
Thanks to [@v4rgas](https://github.com/v4rgas) for maintaining the AUR package!
### Claude Code Plugin (Recommended for Claude Code Users)
### Claude Code Plugin
**The easiest way to use Beads in Claude Code!** One-command installation with zero configuration:
Prefer a one-command installation in Claude Code? Install the beads plugin for instant access via slash commands and MCP tools:
```bash
# In Claude Code
@@ -112,25 +105,11 @@ Thanks to [@v4rgas](https://github.com/v4rgas) for maintaining the AUR package!
/plugin install beads
```
**Why use the plugin?**
- **Zero manual setup** - No need to install Go or build from source
- 🔧 **MCP tools built-in** - Agents can use beads directly without Bash commands
- **Instant availability** - Works immediately after plugin install
- 🎯 **Slash commands** - Quick access to common operations
- 🤖 **Agent-ready** - MCP tools like `mcp__plugin_beads_beads__ready`, `mcp__plugin_beads_beads__create`, etc.
**What you get:**
- **Slash commands**: `/bd-ready`, `/bd-create`, `/bd-show`, `/bd-update`, `/bd-close`, etc.
- **Full MCP server**: All bd tools available via MCP protocol (agents use these automatically)
- **Task agent**: Autonomous task execution
- **Auto-configured**: bd CLI installed and configured automatically
**For agents:** After plugin installation, agents can use MCP tools directly instead of calling `bd` commands via Bash. The plugin provides tools like:
- `mcp__plugin_beads_beads__ready` - Find ready work
- `mcp__plugin_beads_beads__create` - Create new issues
- `mcp__plugin_beads_beads__update` - Update issue status
- `mcp__plugin_beads_beads__show` - Show issue details
- ...and all other bd commands
The plugin includes:
- Slash commands: `/bd-ready`, `/bd-create`, `/bd-show`, `/bd-update`, `/bd-close`, etc.
- Full MCP server with all bd tools
- Task agent for autonomous execution
- Auto-configured for instant use
See [PLUGIN.md](PLUGIN.md) for complete plugin documentation.