=================================
 JDRemindme 0.1 (BETA) README 
=================================

Released 05/10/08 - JonathanDavis.me.uk

==============
INTRODUCTION 
==============

JDRemindMe is a PHP/MySQL application for entering important diary dates
and setting reminders to be notified in advance of these. It utilises
a MySQL database of significant dates with an associated reminder date,
description and further details of the event. These are then checked using
a PHP script run through Crontab on a daily basis and automated emails 
are sent to an email address specified in the configuration file.


==============
REQUIREMENTS
==============

- PHP4 or PHP5
- MySQL Server
- The 'php5-cli' or 'php4-cli' package.
- Crontab

================
GETTING STARTED
================

-  Untar and copy the files onto a folder on your website.

-  Open up 'config.php' in your favourite text editor.

-  Modify the '$username' and '$password' values to grant
   access to the system.

-  Modify the '$sitename' variable to change the name of the
   website if required.

-  Modify the '$checkloc' parameter only if you have moved the 'check.php'
   script to a private directory outside of the JDRemindMe folder. You may
   want to do this for security reasons. 

-  Set the '$emailfrom' and '$emailto' parameters.

-  Import the included 'database.sql' through phpmyadmin or another tool,
   this will then create the MySQL DB structure required.

-  Modify the '$dbname', '$dbhost', '$dbuser' and '$dbpass' variables to 
   match your own MySQL system setup

-  Create a system cron job which will run the 'check.php' script on a daily basis.
   Something like this should do it:

		#!/bin/bash
		php /var/www/mywebsite.com/jdremindme/check.php

   Alternatively you can copy the included example_check file into
   '/etc/cron.daily' and amend the path to point to your own 'check.php' script.

-  Start using it!


=================
CHANGELOG
=================

New features in Version 0.1

    * Login/Logout facility.
    * Config.php which contains login information and email address.
    * Entry form for events with Date, Reminder Date, and Event Details.
    * Listing of upcoming/past events with ability to delete.
    * Reminder check script run daily from crontab using 'check.php' script.
    * Ability to manually run the reminder check script if required.
    * DHTMLGoodies Calendar Integrated 
    * Tango Icon Set

===================
KNOWN LIMITATIONS
===================

- Date format needs amending to UK style.

======================
LICENSE AND COPYRIGHT 
======================

Released under the GNU GPL, see attached licence.txt


================================
CONTACT INFORMATION AND WEBSITE
================================
I welcome your feedback, suggestions and contributions. Contact me
via email if you have questions, feedback, code submissions, 
and bug reports.

For general inquiries - jonathan@jonathandavis.me.uk


