Skip to content

Commit 847823c

Browse files
committed
Add notes to README
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent b2fdc9d commit 847823c

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## actions-usage
22

3-
Find your GitHub Actions usage across a given organisation.
3+
Find your GitHub Actions usage across a given organisation (or user account).
44

55
Includes total runtime of all workflow runs and workflow jobs, including where the jobs were run within inclusive, free, billed minutes, or on self-hosted runners.
66

@@ -19,14 +19,16 @@ If your team has hundreds of repositories, or thousands of builds per month, the
1919

2020
## Usage
2121

22+
This tool is primarily designed for use with an organisation, however you can also use it with a regular user account by changing the `--org` flag to `--user`.
23+
2224
Or create a [Classic Token](https://github.com/settings/tokens) with: repo and admin:org and save it to ~/pat.txt. Create a short lived duration for good measure.
2325

2426
Download a binary from the [releases page](https://github.com/self-actuated/actions-usage/releases)
2527

2628
## Output
2729

2830
```bash
29-
./actions-usage --org openfaas --token $(cat ~/pat.txt)
31+
actions-usage --org openfaas --token $(cat ~/pat.txt)
3032

3133
Fetching last 30 days of data (created>=2023-01-29)
3234

@@ -39,6 +41,12 @@ Total workflow jobs: 113
3941
Total usage: 6h16m16s (376 mins)
4042
```
4143

44+
As a user:
45+
46+
```bash
47+
actions-usage --user alexellis --token $(cat ~/pat.txt)
48+
```
49+
4250
## Development
4351

4452
All changes must be proposed with an Issue prior to working on them or sending a PR. Commits must have a sign-off message, i.e. `git commit -s`

0 commit comments

Comments
 (0)