Skip to content

Commit c5b5d1f

Browse files
authored
Update README.md
1 parent 49f8e46 commit c5b5d1f

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,9 @@
1919

2020
---
2121

22-
### Installation
22+
### Installation (automatic setup)
2323

2424
```bash
25-
# Automatic setup
2625
npx @slkiser/opencode-quota init
2726
```
2827

@@ -48,7 +47,7 @@ opencode-quota show --provider copilot
4847

4948
`show` is quota-only: no token/cost reports or `models.dev` refresh. Installer `None (commands and terminal only)` disables toast/sidebar but keeps `/quota`, `/tokens_*`, and terminal `show`.
5049

51-
### Manual Setup
50+
### Manual setup
5251

5352
Add the server plugin to `opencode.json` or `opencode.jsonc`:
5453

@@ -70,14 +69,14 @@ If you also want the sidebar, add the same package to the `tui.json` or `tui.jso
7069

7170
All quota settings live in `opencode.json` or `opencode.jsonc`, not `tui.json`.
7271

73-
### What It Adds
72+
### What plugin adds
7473

7574
- TUI sidebar panel with quota rows
7675
- Popup quota toasts after assistant responses
7776
- Manual `/quota`, `/quota_status`, and `/tokens_*` commands
7877
- Terminal `opencode-quota show` command for a quota-only quick glance
7978
- Local token reports using bundled and runtime `models.dev` pricing
80-
- Cursor Auto/Composer and Cursor alias pricing that stays deterministic locally
79+
- Custom quota tracking for companion plugins
8180

8281
<table>
8382
<tr>
@@ -128,7 +127,7 @@ Providers are auto-detected by default. To choose providers explicitly:
128127
}
129128
```
130129

131-
### Display Options
130+
### Display options
132131

133132
Show every quota window instead of the default most-constrained window:
134133

@@ -197,7 +196,7 @@ Turn off popup toasts while keeping `/quota` and the sidebar:
197196

198197
<a id="anthropic-claude-quick-setup"></a>
199198

200-
### Anthropic Quick Setup
199+
### Anthropic quick setup
201200

202201
Anthropic does not use a companion OpenCode plugin. Install Claude Code, authenticate it, and make sure `claude` is available on your `PATH`:
203202

@@ -208,7 +207,7 @@ claude auth status
208207

209208
If Claude lives at a custom path, set `experimental.quotaToast.anthropicBinaryPath` in `opencode.json`.
210209

211-
### Companion Providers
210+
### Companion providers
212211

213212
Some providers need an auth companion plugin installed separately. Add the companion plugin first and `@slkiser/opencode-quota` second in `opencode.json` or `opencode.jsonc`.
214213

0 commit comments

Comments
 (0)