From 1a075ec26a596649b1bc4770a3530fdf9ad44a8d Mon Sep 17 00:00:00 2001 From: Alex Ellis Date: Mon, 29 May 2023 17:46:38 +0100 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 891e5dc..8df7530 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,31 @@ arkade get actions-usage sudo mv $HOME/.arkade/bin/actions-usage /usr/local/bin/ ``` -## Output +## Collecting usage before you sign up to actuated.dev + +We sometimes ask users to run this tool before a call with the [actuated team](https://actuated.dev). It helps us gauge your usage, find potential wins and recommend a plan/server. + +```bash +actions-usage \ + --by-repo + --punch-card \ + --org openfaas \ + --token-file ~/pat.txt \ + --days 28 +``` + +If you have either a large or a busy repo - you may want to run with `--days 14` or `--days 7` once your rate limit has reset. ```bash -actions-usage --org openfaas --token-file ~/pat.txt --days 28 +curl -L \ + -H "Accept: application/vnd.github+json" \ + -H "Authorization: Bearer $(cat ~/ae-pat.txt)"\ + -H "X-GitHub-Api-Version: 2022-11-28" \ + https://api.github.com/rate_limit +``` + +## Output + Usage report generated by self-actuated/actions-usage.