johno/beads
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix README and PLUGIN.md documentation issues (#763)

Browse Source 
docs: fix README and PLUGIN.md documentation issues

- Clarify that bd ready shows issues ready to work on (#512)
- Update git hooks install command from deprecated script to bd hooks install (#513)
- Fix Claude Code plugin local install: use ./beads not ., clarify shell vs CC commands (#514)

Fixes #512, #513, #514
This commit is contained in:
Adam Spiers
2025-12-28 01:20:00 +00:00
committed by GitHub
parent d0694e6171
commit d71601d98e
3 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/FAQ.md
+1 -1
View File
@@ -199,7 +199,7 @@ bd automatically:
**Optional**: For immediate export (no 5-second wait) and guaranteed import after git operations, install the git hooks: **Optional**: For immediate export (no 5-second wait) and guaranteed import after git operations, install the git hooks:
```bash ```bash
cd examples/git-hooks && ./install.sh bd hooks install
``` ```
**Disable auto-sync** if needed: **Disable auto-sync** if needed:
docs/PLUGIN.md
+10 -4
View File
@@ -40,17 +40,23 @@ There are two ways to install the beads plugin:
#### Option 2: Local Development #### Option 2: Local Development
```bash ```bash
# Clone the repository # Clone the repository (shell command)
git clone https://github.com/steveyegge/beads git clone https://github.com/steveyegge/beads
cd beads cd beads
```
# Add local marketplace Then in Claude Code:
/plugin marketplace add .
```
# Add local marketplace (Claude Code command)
/plugin marketplace add ./beads
# Install plugin # Install plugin
/plugin install beads /plugin install beads
``` ```
**Note:** If you want to install the plugin from a different repo, first `cd` to that repo's directory in your terminal, then use `./beads` (or the relative path to the beads directory) in Claude Code.
### Restart Claude Code ### Restart Claude Code
After installation, restart Claude Code to activate the MCP server. After installation, restart Claude Code to activate the MCP server.
@@ -282,7 +288,7 @@ git commit -m "Add feature tracking"
# After pull, JSONL auto-imports # After pull, JSONL auto-imports
git pull git pull
bd ready # Fresh data from git! bd ready # Shows issues ready to work on (with fresh data from git)
``` ```
## Updating ## Updating
docs/TROUBLESHOOTING.md
+1 -1
View File
@@ -402,7 +402,7 @@ bd export -o .beads/issues.jsonl
bd import -i .beads/issues.jsonl bd import -i .beads/issues.jsonl
# Install git hooks for guaranteed sync # Install git hooks for guaranteed sync
cd examples/git-hooks && ./install.sh bd hooks install
``` ```
If you disabled auto-sync with `--no-auto-flush` or `--no-auto-import`, remove those flags or use `bd sync` manually. If you disabled auto-sync with `--no-auto-flush` or `--no-auto-import`, remove those flags or use `bd sync` manually.