mirror of
https://git.alemi.dev/ghnotify.git
synced 2024-11-10 02:19:19 +01:00
docs: added a readme
This commit is contained in:
parent
1f3d640e41
commit
60b3780de0
1 changed files with 12 additions and 0 deletions
12
README.md
Normal file
12
README.md
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
# ghnotify
|
||||||
|
Desktop notifications for github. Currently only supports linux (+ maybe BSD?)
|
||||||
|
|
||||||
|
This is a polling solution: no push notifications available. Create a cronjob or systemd timer launching this periodically.
|
||||||
|
|
||||||
|
It requires a GITHUB_TOKEN set in your environment.
|
||||||
|
|
||||||
|
I made this because github notifications are unreliable and messy and there isn't a way to get them on desktop.
|
||||||
|
|
||||||
|
Both `octocrab` and `notify_rust` aren't really exactly what is needed so this software is really awful in its implementation.
|
||||||
|
|
||||||
|
I built this in ~1h and ~50 lines so expect extra awful code.
|
Loading…
Reference in a new issue