From 69b2fe6f948575b94f1c5bcc988370b0fe1e90bf Mon Sep 17 00:00:00 2001 From: CaptainArk Date: Mon, 23 Apr 2018 20:55:48 +0200 Subject: [PATCH] Licensing and credits --- LICENCE | 21 +++++++++++++++++++++ README.md | 6 ++++++ github2email.sh | 7 +++++++ 3 files changed, 34 insertions(+) create mode 100644 LICENCE diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..dd17602 --- /dev/null +++ b/LICENCE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Antoine "CaptainArk" Joubert + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index c591217..ced340a 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,9 @@ Run the script. You're done ! You can also run the script periodically from cron if you want. + +## 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) diff --git a/github2email.sh b/github2email.sh index 9e1a06e..0c0d6c4 100755 --- a/github2email.sh +++ b/github2email.sh @@ -1,5 +1,12 @@ #!/bin/bash +# Github2eMail is a bash script that parses the GitHub API for projects you've +# starred and adds them to your rss2email configuration. +# The script will also delete projects it has added to your rss2email +# configuration if you're not starring them on GitHub anymore. + +# Author : Antoine "CaptainArk" Joubert, 2018 + # Function to clean temporary file ExitCleanup() { if [[ ! -z ${TempFile} ]]; then