Update README.md

- Delayed sending to 7:15 am in the example
- Changed crontab example path
- New section "caveats"
- New section "contributing"
- New section "forks <3", added Raam Dev's pennyarcade-Mailer
This commit is contained in:
Ismo Vuorinen
2013-05-24 10:24:00 +03:00
parent 2c20ebea6f
commit 005b952e6d

View File

@@ -1,10 +1,27 @@
# xkcd-Mailer #
Takes the first/latest item from the xkcd atom-feed and mails the image and punchline to a specified email address.
Takes the first/latest item from the [xkcd](http://xkcd.com/) atom-feed and mails the image and punchline to a specified email address.
## crontab example ##
5 minutes over 7am on monday, wednesday and friday.
15 minutes over 7am on monday, wednesday and friday.
5 7 * * 1,3,5 /usr/bin/php /home/users/viir/code/php/xkcd-mailer.php
15 7 * * 1,3,5 /usr/bin/php /full/path/to/xkcd-mailer.php
## caveats ##
- Script doesn't check has the feed been updated, possibly causing old strip delivery
- You have to modify script to change delivery address, config file could be the solution
## contributing ##
- Fork the code
- Do your changes
- Send pull request
- Bask in glory of open source love
## forks <3 ##
* [raamdev/pennyarcade-Mailer](https://github.com/raamdev/pennyarcade-Mailer) - [Penny Arcade](http://penny-arcade.com/comic) emailer by Raam Dev