Skip to content

Commit 017cc67

Browse files
committed
docs: update README — new screenshot, fix hotkey refs, add Copy.swift to structure
1 parent b3b6bbf commit 017cc67

5 files changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ A macOS menu bar app that monitors your [OpenAI Codex](https://openai.com/index/
2222
![Zero Dependencies](https://img.shields.io/badge/dependencies-zero-success)
2323

2424
<p>
25-
<img src="docs/screenshot.jpg" width="440" alt="Codex Rate Watcher — macOS menu bar app monitoring OpenAI Codex ChatGPT rate limits in real time" />
25+
<img src="docs/screenshot-window.png" width="440" alt="Codex Rate Watcher — macOS menu bar app monitoring OpenAI Codex ChatGPT rate limits in real time" />
2626
</p>
2727

2828
**Real-time quota monitoring · Burn-rate prediction · Multi-account switching · CLI + Raycast**
@@ -68,7 +68,7 @@ Don't just monitor — predict. The burn-rate engine uses linear regression over
6868

6969
v1.4.0 brings Codex rate monitoring to every surface you work on.
7070

71-
- **⌨️ Global Hotkey**`⌘⇧K` toggles the popover from any app (customizable)
71+
- **⌨️ Global Hotkey**`⇧⌃⌥K` toggles the popover from any app (customizable)
7272
- **🖥️ CLI tool**`codex-rate` for terminal-first monitoring, JSON output, and scripting
7373
- **🔍 Raycast extension** — search "Codex" for instant quota checks without leaving your keyboard
7474

@@ -123,7 +123,7 @@ codex-rate history --hours 6
123123

124124
```
125125
╭─────────────────────────────────────────╮
126-
│ Codex Rate Watcher v1.4.0
126+
│ Codex Rate Watcher v1.4.1
127127
╰─────────────────────────────────────────╯
128128
129129
Account: user@example.com (Pro)
@@ -167,11 +167,12 @@ The extension calls `codex-rate --json` under the hood — no separate API keys
167167

168168
## ⌨️ Global Hotkey
169169

170-
Press **⌘⇧K** from any app to toggle the quota popover. No need to click, no need to switch windows.
170+
Press **⇧⌃⌥K** from any app to toggle the quota popover. No need to click, no need to switch windows.
171171

172-
- Customizable — right-click the status bar icon → 热键设置
172+
- Customizable — right-click the status bar icon → Hotkey Settings
173173
- Persisted across launches
174174
- Works in both global and in-app contexts
175+
- Smart conflict detection — warns if your shortcut overlaps with Rectangle, Raycast, etc.
175176

176177
---
177178

@@ -214,7 +215,7 @@ cd codex-rate-watcher
214215
swift build -c release
215216

216217
# Build .app bundle + CLI binary
217-
./scripts/build_app.sh 1.4.0
218+
./scripts/build_app.sh 1.4.1
218219

219220
# Run CLI directly
220221
swift run codex-rate status
@@ -332,11 +333,12 @@ codex-rate-watcher/
332333
│ ├── CodexRateWatcherNative/ # GUI app
333334
│ │ ├── main.swift
334335
│ │ ├── AppDelegate.swift
335-
│ │ ├── HotkeyManager.swift # ⌘⇧K global hotkey
336+
│ │ ├── HotkeyManager.swift # ⇧⌃⌥K global hotkey
336337
│ │ ├── AlertManager.swift
337338
│ │ ├── AuthFileWatcher.swift
338339
│ │ ├── StatusBarIconManager.swift
339340
│ │ ├── UsageMonitor.swift
341+
│ │ ├── Copy.swift # Centralized user-facing strings
340342
│ │ ├── Persistence.swift
341343
│ │ └── PopoverViewController.swift
342344
│ └── codex-rate/ # CLI tool

docs/screenshot-menubar-crop.png

112 KB
Loading

docs/screenshot-menubar.png

1.16 MB
Loading

docs/screenshot-popover-full.png

1.06 MB
Loading

docs/screenshot-window.png

201 KB
Loading

0 commit comments

Comments
 (0)