Skip to content

Commit

Permalink
Document required token permissions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
muesli committed Sep 3, 2021
1 parent 45aa073 commit c4f4b85
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,15 @@ Compiling gitty is easy, simply run:

## Usage

Note: `gitty` requires you to set a GitHub Token as an environment variable called
either `GITHUB_TOKEN` or `GITTY_TOKEN`.
Note: In order to access GitHub's API, `gitty` requires you to provide a valid
GitHub token in an environment variable called either `GITHUB_TOKEN` or
`GITTY_TOKEN`. You can create a new token in your
[profile settings](https://github.com/settings/tokens):

`Developer settings` > `Personal access tokens` > `Generate new token`

Make sure to enable the `repo:status`, `public_repo`, `read:user`, and
`read:org` permissions in particular.

### Basic usage

Expand Down

0 comments on commit c4f4b85

Please sign in to comment.