2018-04-19 20:57:13 +02:00
|
|
|
# Github2eMail
|
|
|
|
|
|
|
|
|
|
## What is it ?
|
|
|
|
|
|
|
|
|
|
Github2eMail is a bash script that parses the GitHub API for projects you've starred and adds them to your rss2email configuration.
|
|
|
|
|
|
2018-04-19 23:38:17 +02:00
|
|
|
The script will also delete projects it has added to your rss2email configuration if you're not starring them on GitHub anymore.
|
|
|
|
|
|
2018-04-19 20:57:13 +02:00
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
|
|
- [curl](https://github.com/curl/curl)
|
|
|
|
|
- [rss2email](https://github.com/wking/rss2email)
|
|
|
|
|
- [jq](https://github.com/stedolan/jq)
|
|
|
|
|
|
|
|
|
|
## How do I use it ?
|
|
|
|
|
|
|
|
|
|
You need to have installed and configured rss2email first.
|
|
|
|
|
|
|
|
|
|
Clone this repo.
|
|
|
|
|
|
|
|
|
|
Edit the `config` file and modify the `UserName` variable to your GitHub username.
|
|
|
|
|
|
|
|
|
|
Run the script.
|
|
|
|
|
|
|
|
|
|
You're done !
|
|
|
|
|
|
|
|
|
|
You can also run the script periodically from cron if you want.
|
2018-04-23 20:55:48 +02:00
|
|
|
|
|
|
|
|
## Credits and licence
|
|
|
|
|
|
|
|
|
|
This script was first written by Antoine "CaptainArk" Joubert in 2018.
|
|
|
|
|
|
|
|
|
|
This script is made avaialble under the [MIT licence](https://github.com/captainark/github2email/blob/master/LICENCE)
|
