Skip to content

Commit

Permalink
Add explanation about private repositories
Browse files Browse the repository at this point in the history
  • Loading branch information
sirbrillig committed May 12, 2017
1 parent d760c5e commit 7d85f52
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ A simple node module to fetch GitHub notifications.

Made to be used by [gitnews-cli](https://github.com/sirbrillig/gitnews-cli) and [gitnews-menubar](https://github.com/sirbrillig/gitnews-menubar).

Since this module uses a custom token, it can report on private repositories as well as public ones.

# Install

Using npm:
Expand All @@ -20,7 +22,7 @@ yarn add gitnews

# Usage

You must first create GitHub token. To create the token, visit the [Tokens](https://github.com/settings/tokens) page and generate a new token for the app. You can call it "gitnews" and it needs at least `notifications` scope and the `repo` scope.
You must first create a GitHub token so the module has access to your notifications. To create the token, visit the [Tokens](https://github.com/settings/tokens) page and generate a new token for the app. You can call it "gitnews" and it needs at least `notifications` scope and the `repo` scope.

Then import the `getNotifications` named function and pass it the token. (There is also a `getReadNotifications` function to return already-read notifications.)

Expand Down

0 comments on commit 7d85f52

Please sign in to comment.