Skip to content

Commit bf7ee84

Browse files
committed
docs: add CHANGELOG, RELEASE guide, and LICENSE
1 parent 396d8c6 commit bf7ee84

3 files changed

Lines changed: 64 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
6+
7+
## [1.0.0] - 2026-03-03
8+
9+
- 🔔 Real-time unread count badge and desktop notifications
10+
- 📋 Issues, PRs, Releases, and all notification types with rich details
11+
- ✅ Mark as read per notification, per repository, or all at once
12+
- 🔐 OAuth Device Flow or Personal Access Token authentication
13+
- ✨ Clean, minimal UI — feature-rich without the clutter
14+
- 🎨 Light / Dark / System theme with adjustable popup width

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 GitHub Notifier Pro contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

RELEASE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Release Guide
2+
3+
## Steps to Release a New Version
4+
5+
1. Update CHANGELOG.md:
6+
- Add version entry: `## [X.Y.Z] - YYYY-MM-DD` with changes
7+
8+
2. Update version in `package.json` and `manifest.json`:
9+
```sh
10+
# Edit both files to set "version": "X.Y.Z"
11+
```
12+
13+
3. Commit changes:
14+
```sh
15+
git add CHANGELOG.md package.json manifest.json manifest-firefox.json
16+
git commit -m "chore: update version to vX.Y.Z"
17+
git push origin main
18+
```
19+
20+
4. Run the release workflow:
21+
```sh
22+
gh workflow run release.yml
23+
```
24+
This will run tests, build Chrome & Firefox packages, and create a GitHub Release with the zip files.
25+
26+
5. Update the release notes on GitHub if needed:
27+
```sh
28+
gh release edit vX.Y.Z --notes "Release notes here"
29+
```

0 commit comments

Comments
 (0)