Skip to content

Commit 024b85f

Browse files
authored
Update token explanation in readme (sindresorhus#307)
1 parent 775edfd commit 024b85f

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

readme.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,38 @@ Checks for new GitHub notifications every minute, shows the number of notificati
2626

2727
## Screenshots
2828

29+
### Options
30+
31+
![Options page for Notifier for GitHub](media/screenshot-options.png)
32+
2933
### Notification Count
3034

3135
![Screenshot of extension should notification count](media/screenshot.png)
36+
## GitHub Token Setup
3237

33-
### Options
38+
### Token Types Supported
3439

35-
![Options page for Notifier for GitHub](media/screenshot-options.png)
40+
This extension requires a GitHub personal access token to function properly. You can follow instructions from GitHub to create a personal access token in your account.
41+
42+
**Important:** Only classic personal access tokens are currently supported. Fine-grained personal access tokens cannot be used at this time. This limitation is tracked in an [open issue](https://github.com/sindresorhus/notifier-for-github/issues/283).
43+
44+
### Repository Permissions
45+
46+
#### For Private Repository Notifications
3647

37-
## Permissions
48+
To receive desktop notifications for private repositories, you must create a personal access token with the `repo` scope. This requirement exists because of GitHub's current permission structure - accessing any information about private repositories requires full repository control permissions.
49+
50+
#### Security Considerations
51+
52+
If you have security concerns about granting the `repo` scope, you can skip this permission. However, be aware of the following tradeoff:
53+
54+
- **Without `repo` scope:** Clicking on notifications will redirect you to the general notifications homepage instead of the specific repository or issue
55+
- **With `repo` scope:** Clicking on notifications will take you directly to the relevant repository content
56+
57+
The choice between security and functionality is yours based on your comfort level with the permissions required.
58+
59+
60+
## Extension Permissions
3861

3962
The extension requests a couple of optional permissions. It works as intended even if you disallow these. Some features work only when you grant these permissions as mentioned below.
4063

@@ -48,12 +71,6 @@ This permission also lets us update the notification count immediately after ope
4871

4972
If you want to receive desktop notifications for public repositories, you can enable them on extension options page. You will then be asked for the `notifications` permission.
5073

51-
### Repos Permission
52-
53-
If you want to receive (useful) desktop notifications for any private repositories you have, you will have to create a GitHub personal access token that has access to the `repo` scope as well. This is due to GitHub's current permission scheme, as the only way we can read anything about your private repos is if we have full control over repositories.
54-
55-
If you're concerned with your security in this manner, please feel free to ignore this scope. Just be aware that if you do not grant this scope, clicking on the notification will take you to the notifications home page, since we can't get any information about the repo you got the notification for.
56-
5774
## Configuration
5875

5976
### Desktop Notifications

0 commit comments

Comments
 (0)