alemi/ghnotify
1
0
Fork 0
mirror of https://git.alemi.dev/ghnotify.git synced 2024-11-23 07:54:51 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: added a readme

Browse source
This commit is contained in:
əlemi 2023-07-22 17:16:44 +02:00
parent 1f3d640e41
commit 60b3780de0
Signed by: alemi
GPG key ID: A4895B84D311642C
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md Normal file
View 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.