Skip to content

Commit

Permalink
Updated readme (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
IgorTatarnikov authored Sep 9, 2024
1 parent 024d3ff commit 2d09420
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ You will need to set a secret in the repository settings. The secret is a GitHub
The secret should be named `GRAPHQL_TOKEN`. You can set this for your repository in `Settings` -> `Secrets and variables` -> `Actions`.

We use the PEPY API to fetch package download data. In order to fetch this data you will need an API key from [PEPY](https://www.pepy.tech/pepy-api).
You can set this key in the repository secrets as `PEPY_API_KEY`.

### Configuration

There is a `config.yml` located in the root of the project that contains the configuration for the project. The configuration is as follows:
Expand Down Expand Up @@ -83,6 +86,8 @@ The `GRAPHQL_TOKEN` token requires the following scopes:
> [!NOTE]
> To fetch collaborator counts, you need to provide a token that is an admin of the organization.

The `PEPY_API_KEY` must be set in the `.env` file to fetch package download data.

### Installation

```sh
Expand Down

0 comments on commit 2d09420

Please sign in to comment.