Skip to content

Commit 4a41ee8

Browse files
committed
wip
1 parent f63e191 commit 4a41ee8

File tree

4 files changed

+219
-8
lines changed

4 files changed

+219
-8
lines changed

.prettierignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@ dist
22
node_modules
33
package-lock.json
44
__INTERNAL__
5+
CLAUDE.md
6+
AGENTS.md

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
<div align="center">
22

3-
<img src="assets/header.svg" alt="GitHub API Usage Tracker" width="600"/>
4-
5-
<br><br>
3+
<img src="assets/header-banner.svg" alt="GitHub API Usage Tracker" width="700"/>
64

75
[![GitHub Actions](https://img.shields.io/badge/GitHub-Action-2088FF?style=for-the-badge&logo=github-actions&logoColor=white)](https://github.com/features/actions)
86
[![Node.js](https://img.shields.io/badge/Node.js-20+-339933?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/)
@@ -18,7 +16,7 @@ This action captures the rate-limit state at job start and compares it with the
1816

1917
## Usage
2018

21-
To use this action, just drop it in anywhere in your job - the pre- and post-job hooks will do all of the work. (CAVEAT: See "Reset Windows" section below for a nuance.)
19+
To use this action, just drop it in anywhere in your job - the pre- and post-job hooks will do all of the work. (CAVEAT: This holds true for most use cases, but see "Reset Windows" section below.)
2220

2321
```yaml
2422
jobs:
@@ -37,11 +35,11 @@ jobs:
3735
...
3836
```
3937

40-
After your job completes, you'll get a nice summary:
38+
After your job completes, you'll get a nice summary in the workflow UI:
4139

42-
<div align="center">
43-
<img src="assets/flow-diagram.svg" alt="API Usage Tracking Flow" width="100%"/>
44-
</div>
40+
<picture>
41+
<img width="600" src="./assets/workflow-summary-example.png">
42+
</picture>
4543

4644
## Inputs
4745

assets/header-banner.svg

Lines changed: 211 additions & 0 deletions
Loading
110 KB
Loading

0 commit comments

Comments
 (0)