diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..92a2dcb --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +config.php +.DS_Store diff --git a/README.md b/README.md index 27d88be..255bba9 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,37 @@ Takes the first/latest item from the [xkcd](http://xkcd.com/) atom-feed and mails the image and punchline to a specified email address. +## configuration ## + +The script needs a simple configuration. Modify ``config.example.php`` to fit your needs and save as ``config.php`` + +```php +"; +``` + + ## crontab example ## 15 minutes over 7am on monday, wednesday and friday. - + 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 ## diff --git a/config.example.php b/config.example.php new file mode 100644 index 0000000..cce6213 --- /dev/null +++ b/config.example.php @@ -0,0 +1,15 @@ +"; + diff --git a/xkcd-mailer.php b/xkcd-mailer.php index 106dc57..1504c9f 100644 --- a/xkcd-mailer.php +++ b/xkcd-mailer.php @@ -6,17 +6,18 @@ * strip with alt/title-text underneath the image. * * @author Ismo Vuorinen - * @version 23 August, 2010 + * @version 1.0.20130619 * @license http://www.opensource.org/licenses/mit-license.php The MIT License * @package default **/ - - // Your timezone, PHP5 required. - date_default_timezone_set("Europe/Helsinki"); - - // Your destination - $mail = "ivuorinen@me.com"; - $from = "xkcd mailer "; + + // Use config.example.php as base for your configurations. + $here = dirname( __FILE__ ); + if( !is_readable($here . '/config.php') ) { + die("Please configure me. I don't know where I should sent the comic. (Config file {$here}/config.php missing.)"); + } else { + include_once($here . '/config.php'); + } $feed = "http://xkcd.com/atom.xml"; $data = simplexml_load_file($feed);