Skip to content

Commit 1161254

Browse files
committed
docs: clarify readme billing states
Simplify the README introduction and tooltip copy so the extension behavior is easier to scan. Clarify overage and no-data status descriptions after adding Free token-based Credits support.
1 parent b89d644 commit 1161254

1 file changed

Lines changed: 4 additions & 7 deletions

File tree

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
# GitHub Copilot Usage
22

3-
<div>
4-
<p>Shows Copilot Premium request / Credit usage in the VS Code status bar, right next to the Copilot icon. Adapts to legacy or token-based billing.</p>
5-
<p>e.g., <code>25%</code> normal · <code>75%</code> yellow warning · <code>95%</code> red critical.</p>
6-
</div>
3+
Show GitHub Copilot Premium Requests or Credits usage in the VS Code status bar, next to the Copilot icon. Supports both legacy and token-based billing.
74

85
[![VS Code Marketplace](https://img.shields.io/badge/VS%20Code-Marketplace-blue?logo=visual-studio-code&logoColor=white)](https://marketplace.visualstudio.com/items?itemName=euxx.github-copilot-usage)
96

107
## Features
118

129
- **Status bar**: shows used percentage (`15%`), turns yellow/red near threshold
13-
- **Hover tooltip**: titled **Copilot Premium Requests** or **Copilot Credits** depending on the billing mode; shows plan, `Used: X / Y (Z%)`, overage, reset date, last-updated timestamp — with refresh button and link to [Premium request analytics](https://github.com/settings/billing/premium_requests_usage)
10+
- **Hover tooltip**: shows plan, usage, overage, reset date, last update, refresh button, and [billing analytics](https://github.com/settings/billing/premium_requests_usage)
1411
- **Auto-refresh**: configurable interval (default 5 min)
1512
- **Zero config**: uses your existing VS Code GitHub account sign-in
1613

@@ -28,9 +25,9 @@
2825
| `75%` (yellow) | Warning threshold reached |
2926
| `90%` (red) | Critical threshold reached |
3027
| `100%` (red) | Pooled entitlement exhausted (enterprise unlimited, no overage) |
31-
| `111%` (red) | Overage — actual usage exceeds |
28+
| `111%` (red) | Overage — actual usage exceeds quota |
3229
| `` | Unlimited plan |
33-
| `` | No premium quota data (plan has no tracked limit) |
30+
| `` | No quota data to display |
3431
| `` | Loading |
3532
| `` | Server error or access denied |
3633
| `` | Offline or rate limited — no cached data available |

0 commit comments

Comments
 (0)