properly generate full-day ical events

[bdrem.git] / README.rst

diff --git a/README.rst b/README.rst
index 66d0da289402002b90258606585cbb8d4c448ad3..703dfcb437dcd7ddbe35b3793e67fb0fca05a76b 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -24,6 +24,7 @@ Output formats
 - ASCII table
 - HTML
 - Email (text + HTML parts)
+- iCalendar
 
 
 =====
@@ -80,6 +81,24 @@ If you only want an email if there is a birthday, use ``--stoponempty``::
 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``.