*********************************
Birthday reminder that sends out e-mails.
-It can also generate ASCII tables on your console/shell and normal HTML pages.
+It can also generate ASCII tables on your console, iCalendar files
+and normal HTML pages.
.. contents::
- Multiple date fields per record supported.
- An LDAP server
-- `Birthday reminder <http://cweiske.de/birthday3.htm>` files (``.bdf``)
+- `Birthday reminder <http://cweiske.de/birthday3.htm>`_ files (``.bdf``)
Output formats
==============
- ASCII table
- HTML
- Email (text + HTML parts)
+- iCalendar
=====
Make sure your config file contains ``$mail_from`` and ``$mail_to`` settings.
+iCalendar
+=========
+Exporting birthday events into an ``.ics`` file is easy::
+
+ $ bdrem --renderer=ical > birthdays.ics
+
+It is possible to access the calendar via HTTP, too::
+
+ http://example.org/bdrem/?renderer=ical
+
+You can subscribe to it in your calendar or email application.
+Integration has been tested with Thunderbird's Lightning__ and Claws Mail's
+vCalendar__ plugin.
+
+__ https://addons.mozilla.org/en-US/thunderbird/addon/lightning/
+__ http://www.claws-mail.org/plugin.php?plugin=vcalendar
+
+
HTML page
=========
Simply point your web browser to the ``.phar`` file, or ``index.php``.
- `Net_LDAP2 <https://pear.php.net/package/Net_LDAP2>`_
+Note that the ``.phar`` file already includes all dependencies;
+you do not need to install anything.
+
+
=======
License
=======