Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

docs: Improve README clarity and formatting

Maximilian Roos489361b44321
diff --git a/README.md b/README.md
index d24a2b0d8..3a70537a9 100644
--- a/README.md
+++ b/README.md
@@ -389,19 +389,9 @@ All checks passed!
See `wt switch --help` and `wt merge --help` for skipping hooks, template variables, security details.
-### Custom Worktree Status
+### Claude Code Status Tracking
-Add emoji status markers to branches that appear in `wt list`.
-
-```console
-# Set status for current branch
-wt config status set "πŸ€–"
-
-# Or use git config directly
-git config worktrunk.status.feature-x "πŸ’¬"
-```
-
-**Status appears in the Status column:**
+The Worktrunk plugin adds Claude Code session tracking to `wt list`:
<!-- ⚠️ AUTO-GENERATED from tests/snapshots/integration__integration_tests__list__with_user_status.snap β€” edit source to update -->
@@ -418,25 +408,26 @@ $ wt list
<!-- END AUTO-GENERATED -->
-The custom emoji appears directly after the git status symbols.
-
-<details>
-<summary>Automation with Claude Code Hooks</summary>
+- `πŸ€–` β€” Claude is working (processing a prompt)
+- `πŸ’¬` β€” Claude is idle or waiting for input
-Claude Code can automatically set/clear emoji status when coding sessions start and end.
+**Install the plugin:**
-When using Claude:
+```console
+claude plugin marketplace add max-sixty/worktrunk
+claude plugin install worktrunk@worktrunk
+```
-- Sets status to `πŸ€–` for the current branch when submitting a prompt (working)
-- Changes to `πŸ’¬` when Claude needs input (waiting for permission or idle)
-- Clears the status completely when the session ends
+<details>
+<summary>Manual status markers</summary>
-**How it works:**
+Set status markers manually for any workflow:
-- Status is stored as `worktrunk.status.<branch>` in `.git/config`
-- Each branch can have its own status emoji
-- The hooks automatically detect the current branch and set/clear its status
-- Works with any git repository, no special configuration needed
+```console
+wt config status set "🚧" # Current branch
+wt config status set "βœ…" --branch feature # Specific branch
+git config worktrunk.status.feature "πŸ’¬" # Direct git config
+```
</details>