Skip to content

Commit 3ae6406

Browse files
docs(README): improve documentation
1 parent a944139 commit 3ae6406

File tree

2 files changed

+46
-7
lines changed

2 files changed

+46
-7
lines changed

README.md

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,57 @@
1-
<h1 align="center">
2-
GitHub Notifications
3-
</h1>
4-
<p align="center">
5-
🔔 Get GitHub's notifications directly on your Mac Status Bar
6-
</p>
71
<div align="center">
2+
<img
3+
src="./GitHub%20Notifications/Assets.xcassets/AppIcon.appiconset/AppIcon256.png"
4+
width="200"
5+
height="200"
6+
/>
7+
<h1>
8+
GitHub Notifications
9+
</h1>
10+
<p>
11+
<strong>🔔 Get GitHub's notifications directly on your Mac Status Bar</strong>
12+
</p>
13+
<br />
14+
<br />
15+
<br />
16+
</div>
17+
18+
This macOS application is useful to let you know when you have notifications on
19+
your GitHub account.
20+
21+
Require macOS 10.15 or later.
22+
23+
<div>
824
<img src="./assets/screenshot_01.png" alt="Overview of the GitHub Notifications menu bar application" />
925
</div>
1026

27+
## Download
28+
29+
<!-- TODO add the link to the download -->
30+
31+
## Features
32+
33+
### Know when you have a notification
34+
35+
By default, the application is a simple icon in your macOS status bar, and a
36+
little indicator appears when you have notifications.
37+
38+
### Access [github.com/notifications](https://github.com/notifications) from the menu first item
39+
40+
Click on the application in the status bar, and then click on the menu first
41+
item to access the [GitHub Notifications](https://github.com/notifications)
42+
page.
43+
44+
## FAQ
45+
46+
### I can't paste my Personal Access Token using keyboard shortcut.
47+
48+
> You have to right click in the field in order to paste your personal access
49+
> token as the keyboard shortcut is not yet implemented.
1150
1251

1352

1453
---
1554

1655
## My git related projects
1756

18-
- [gitweb](https://github.com/yoannfleurydev/gitweb)
57+
- [gitweb](https://github.com/yoannfleurydev/gitweb) 🌲 Open the current remote repository in your browser

assets/screenshot_01.png

224 KB
Loading

0 commit comments

Comments
 (0)