Skip to content

Commit d19e5eb

Browse files
committed
docs: update README and development instructions for clarity and structure
1 parent f711923 commit d19e5eb

2 files changed

Lines changed: 31 additions & 63 deletions

File tree

README.md

Lines changed: 16 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,32 @@
11
# GitHub Notifier Pro
22

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">
44

5-
![Chrome](https://img.shields.io/badge/Chrome-MV3-green) ![Firefox](https://img.shields.io/badge/Firefox-supported-orange)
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>
89

9-
<!-- Add your screenshot here -->
10-
11-
![Popup Screenshot](images/screenshot.png)
10+
![Chrome](https://img.shields.io/badge/Chrome-MV3-green) ![Firefox](https://img.shields.io/badge/Firefox-supported-orange)
1211

1312
## Features
1413

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
5920

6021
## Usage
6122

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)
6725

6826
## Development
6927

70-
See [development.md](development.md) for build instructions and contribution guidelines.
28+
See [development.md](development.md) for installation, building, and setup.
7129

7230
## License
7331

74-
MIT
32+
Under the [MIT](LICENSE) License.

development.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
# Development
22

3-
## Setup
3+
## Installation from Source
44

5-
```bash
6-
npm install
7-
npm run prepare
8-
```
5+
1. Clone the repository
6+
2. Install dependencies and set up git hooks:
7+
```bash
8+
npm install
9+
npm run prepare
10+
```
11+
3. Configure OAuth:
12+
```bash
13+
cp src/config/config.example.js src/config/config.js
14+
# Edit config.js with your GitHub OAuth App Client ID
15+
```
16+
4. Load in browser:
17+
- **Chrome**: `chrome://extensions` → Enable Developer mode → Load unpacked → Select project folder
18+
- **Firefox**: Run `npm run dev:firefox`, then `about:debugging` → Load Temporary Add-on → Select `dist/firefox-dev/manifest.json`
919

1020
## Scripts
1121

0 commit comments

Comments
 (0)