burnbar 0.0.0-dev.39.1 → 0.0.0-dev.41.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,11 +15,11 @@ See how fast you're burning through your plan limits without leaving what you're
|
|
|
15
15
|
|
|
16
16
|
[Features](#features) • [See it in action](#see-it-in-action) • [Installation](#installation) • [Build from source](#build-from-source)
|
|
17
17
|
|
|
18
|
-
<img src="docs/images/
|
|
18
|
+
<img src="docs/images/milestone-popup-dark.png" alt="BurnBar brief usage milestone notification" width="410">
|
|
19
19
|
|
|
20
20
|
</div>
|
|
21
21
|
|
|
22
|
-
Claude and Codex have session and longer-term plan limits. BurnBar keeps both providers in a
|
|
22
|
+
Claude and Codex have session and longer-term plan limits. BurnBar keeps both providers in a tray-anchored card when you need it, warns you before you run out, and shows whether you're using them faster than the time
|
|
23
23
|
window allows. Use both together, or select one from **Usage providers** in the right-click menu.
|
|
24
24
|
Codex window lengths come from your account rather than assuming every plan uses the same limits.
|
|
25
25
|
|
|
@@ -29,17 +29,26 @@ Codex window lengths come from your account rather than assuming every plan uses
|
|
|
29
29
|
|
|
30
30
|
## Features
|
|
31
31
|
|
|
32
|
-
- **
|
|
33
|
-
|
|
34
|
-
It
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
32
|
+
- **Brief milestone popups**: by default, a small framed card appears when either
|
|
33
|
+
provider's primary/session or secondary/weekly quota crosses **10%, 20%, … 100%**.
|
|
34
|
+
It shows the affected provider, takes no focus, and closes after **6 seconds**.
|
|
35
|
+
More updates do not keep extending it. Jumps show only the highest new milestone,
|
|
36
|
+
not a burst of every skipped threshold.
|
|
37
|
+
- **Quiet by default**: first readings establish a baseline instead of replaying
|
|
38
|
+
old milestones. Saved per-window state avoids duplicates on refresh or restart;
|
|
39
|
+
quota resets rearm the tracker. Crossings are detected on the next successful
|
|
40
|
+
refresh, not continuously between API reads.
|
|
41
|
+
- **Your choice**: click the tray icon any time to inspect usage; click an automatic
|
|
42
|
+
notice to keep it open and show details. Right-click → **Milestone popups (10% steps,
|
|
43
|
+
6 sec)** disables automatic cards for click-only use. **Always show popup (optional)**
|
|
44
|
+
restores a persistent overview if preferred. Esc or clicking elsewhere closes
|
|
45
|
+
manual views unless always-show is enabled.
|
|
46
|
+
- **Fullscreen-aware**: no automatic popup appears over a fullscreen app, and missed
|
|
47
|
+
milestones are not queued to interrupt you afterwards. Cards follow light/dark
|
|
48
|
+
theme, DPI and the notification icon, and remain inside the monitor's work area.
|
|
40
49
|
- **Optional taskbar meter**: enable **Show taskbar meter (optional)** for the rotating
|
|
41
50
|
compact bars. Existing taskbar preferences are preserved when updating; new profiles
|
|
42
|
-
use the
|
|
51
|
+
use the tray and brief notices instead. Bars turn red at 90%.
|
|
43
52
|
- **Pace marker**: a tick on each bar shows how much of the window's time has passed.
|
|
44
53
|
A bar past its tick means you'll hit the limit before it resets.
|
|
45
54
|
- **Details panel**: separate provider panels, reported quota windows, reset times, and independent
|
|
@@ -54,13 +63,17 @@ Codex window lengths come from your account rather than assuming every plan uses
|
|
|
54
63
|
- **About**: right-click the meter or tray icon for the app version, developer credits,
|
|
55
64
|
and a link to this repository.
|
|
56
65
|
|
|
66
|
+
Existing installations using the previous always-visible default switch to the
|
|
67
|
+
quieter milestone mode once on upgrade. You can opt back into always-show after
|
|
68
|
+
updating; that explicit choice is retained. See [popup behavior](docs/POPUP_BEHAVIOR.md).
|
|
69
|
+
|
|
57
70
|
## See it in action
|
|
58
71
|
|
|
59
72
|
<div align="center">
|
|
60
|
-
<img src="docs/images/
|
|
61
|
-
<img src="docs/images/
|
|
73
|
+
<img src="docs/images/milestone-popup-light.png" alt="BurnBar milestone popup, light theme" width="400">
|
|
74
|
+
<img src="docs/images/milestone-popup-dark.png" alt="BurnBar milestone popup, dark theme" width="400">
|
|
62
75
|
<br>
|
|
63
|
-
<sub>Rendered demo previews:
|
|
76
|
+
<sub>Rendered demo previews: a milestone notice that closes automatically. Click to inspect details.</sub>
|
|
64
77
|
</div>
|
|
65
78
|
|
|
66
79
|
<details>
|
|
@@ -79,7 +92,7 @@ You need Windows 10 or 11 and a signed-in provider:
|
|
|
79
92
|
(`codex login`). API-key-only accounts do not provide these subscription usage limits.
|
|
80
93
|
BurnBar also detects the CLI bundled with the Windows Codex desktop app when available.
|
|
81
94
|
|
|
82
|
-
Both providers
|
|
95
|
+
Both providers are available from the tray; automatic notices show the affected provider. A missing login affects only that provider. Select
|
|
83
96
|
**Usage providers** from the right-click menu to hide a provider you don't use.
|
|
84
97
|
|
|
85
98
|
### Install or update with npx
|
|
@@ -192,6 +205,7 @@ internal/usage/ Claude usage client and Codex app-server account client
|
|
|
192
205
|
internal/render/ drawing the meter, details panel, charts and tray icon
|
|
193
206
|
internal/layout/ choosing a free spot on the taskbar
|
|
194
207
|
internal/config/ settings and alert state
|
|
208
|
+
internal/alerts/ milestone deduplication and popup lifetime
|
|
195
209
|
internal/history/ usage history for the charts
|
|
196
210
|
tools/genres/ icon and Windows resource generator
|
|
197
211
|
assets/ app icon
|