Skip to content

Commit

Permalink
improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bullrich committed Jul 18, 2024
1 parent 71e74a4 commit ba11b28
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Supports obtaining metrics from:
- Pull Requests
- Issues

It also supports obtaining user metrics related to a repository.

## To start

### Run from CLI
Expand All @@ -19,12 +21,16 @@ If the repository is private you will need to enable the `repo` option.

Copy `example.env` as `.env` and replace the variables with your own.

> If you want to get a user's related metric, write their username in the `author` field, if not, just delete this field.
Run:

- `yarn install`
- `yarn run cli`

It will generate a file named `report.md` as the output.
It will generate two files:
- `report.md`
- `index.html`

### Run as GitHub action

Expand Down

0 comments on commit ba11b28

Please sign in to comment.