|
1 | 1 | # GitHub Notifier Pro |
2 | 2 |
|
3 | | -A browser extension that brings GitHub notifications to your browser toolbar. |
| 3 | +<img src="images/icon.png" width="100" alt="GitHub Notifier Pro" align="left"> |
4 | 4 |
|
5 | | -  |
6 | | - |
7 | | -## Screenshot |
| 5 | +<div> |
| 6 | + <p>GitHub notifications in your browser toolbar.</p> |
| 7 | + <p>Supports Chrome 99+ (MV3) and Firefox 110+.</p> |
| 8 | +</div> |
8 | 9 |
|
9 | | -<!-- Add your screenshot here --> |
10 | | - |
11 | | - |
| 10 | +  |
12 | 11 |
|
13 | 12 | ## Features |
14 | 13 |
|
15 | | -- **Real-time notifications** - Badge shows unread count, auto-refreshes in background |
16 | | -- **Adaptive polling** - Automatically adjusts refresh interval (60s-10min) based on GitHub's X-Poll-Interval header |
17 | | -- **Smart caching** - Uses HTTP 304 responses to minimize API calls and bandwidth |
18 | | -- **Rate limit protection** - Tracks GitHub API limits with visual indicators and automatic retry |
19 | | -- **Desktop alerts** - Optional native notifications for new items |
20 | | -- **Quick actions** - Open, mark as read, or mark all as read |
21 | | -- **Rich details** - Shows PR state, issue status, author avatars |
22 | | -- **Secure auth** - OAuth Device Flow (no secret needed) or PAT |
23 | | - |
24 | | -## Permissions |
25 | | - |
26 | | -This extension requires: |
27 | | - |
28 | | -| Permission | Purpose | |
29 | | -| ---------------- | -------------------------------- | |
30 | | -| `notifications` | Show desktop notifications | |
31 | | -| `storage` | Store auth token and preferences | |
32 | | -| `alarms` | Background polling | |
33 | | -| `identity` | OAuth authentication flow | |
34 | | -| `api.github.com` | Fetch notifications | |
35 | | -| `github.com` | OAuth authentication | |
36 | | - |
37 | | -**OAuth Scopes**: `repo`, `notifications` |
38 | | - |
39 | | -## Installation |
40 | | - |
41 | | -### From Source |
42 | | - |
43 | | -1. Clone the repository |
44 | | -2. Configure OAuth: |
45 | | - ```bash |
46 | | - cp src/config/config.example.js src/config/config.js |
47 | | - # Edit config.js with your GitHub OAuth App Client ID |
48 | | - ``` |
49 | | -3. Load in browser: |
50 | | - - **Chrome**: `chrome://extensions` → Enable Developer mode → Load unpacked → Select project folder |
51 | | - - **Firefox**: Run `npm run dev:firefox`, then `about:debugging` → Load Temporary Add-on → Select `dist/firefox-dev/manifest.json` |
52 | | - |
53 | | -### Build for Distribution |
54 | | - |
55 | | -```bash |
56 | | -npm run build |
57 | | -# Outputs: dist/github-notifier-pro-chrome.zip and dist/github-notifier-pro-firefox.zip |
58 | | -``` |
| 14 | +- 🔔 Real-time unread count badge and desktop notifications |
| 15 | +- 📋 Issues, PRs, Releases, and all types with rich details |
| 16 | +- ✅ Mark as read per notification, per repository, or all at once |
| 17 | +- 🔐 OAuth Device Flow or Personal Access Token authentication |
| 18 | +- ✨ Clean, minimal UI — feature-rich without the clutter |
| 19 | +- 🎨 Light / Dark / System theme with adjustable popup width |
59 | 20 |
|
60 | 21 | ## Usage |
61 | 22 |
|
62 | | -### Authentication |
63 | | - |
64 | | -1. **OAuth (recommended)** - Click "Sign in with GitHub", enter the code on GitHub |
65 | | -2. **Personal Access Token** - Generate a token with `repo` and `notifications` scopes at [GitHub Settings](https://github.com/settings/tokens) |
66 | | - |
| 23 | +1. **OAuth (recommended)** — Click "Sign in with GitHub", enter the code on GitHub |
| 24 | +2. **Personal Access Token** — Generate a token with `repo` and `notifications` scopes at [GitHub Settings](https://github.com/settings/tokens) |
67 | 25 |
|
68 | 26 | ## Development |
69 | 27 |
|
70 | | -See [development.md](development.md) for build instructions and contribution guidelines. |
| 28 | +See [development.md](development.md) for installation, building, and setup. |
71 | 29 |
|
72 | 30 | ## License |
73 | 31 |
|
74 | | -MIT |
| 32 | +Under the [MIT](LICENSE) License. |
0 commit comments