X-Git-Url: https://git.cweiske.de/bdrem.git/blobdiff_plain/1cec5b9cdc9776f2321a488d09602cfa971c5d93..96ad995ae69cf445542ed19d64e84b19c9623e35:/README.rst

diff --git a/README.rst b/README.rst
index 07d224b..e503d3b 100644
--- a/README.rst
+++ b/README.rst
@@ -19,6 +19,7 @@ Data sources
   - Multiple date fields per record supported.
 - An LDAP server
 - `Birthday reminder <http://cweiske.de/birthday3.htm>`_ files (``.bdf``)
+- CSV files
 
 Output formats
 ==============
@@ -133,6 +134,63 @@ __ http://cweiske.de/birthday.htm
 __ http://cweiske.de/birthday3.htm 
 
 
+CSV file
+========
+Comma separated value files can be used with bdrem.
+They should at least contain a column with the name, and one with the date.
+
+Simple configuration if you use the default settings::
+
+    $source = array(
+        'Csv',
+        '/path/to/file.csv'
+    );
+
+Complex configuration::
+
+    $source = array(
+        'Csv',
+        array(
+            'filename' => '/path/to/file.csv',
+            'columns' => array(
+                'name'  => 0,
+                'event' => 1,
+                'date'  => 2
+            ),
+            'firstLineIsHeader' => true,
+            'defaultEvent' => 'Birthday',
+            'separator' => ',',
+        )
+    );
+
+Configuration options
+---------------------
+``columns``
+  Determines the position of the name, event and date columns.
+  ``0`` is the first column.
+  You can use ``false`` to disable a column; helpful if there is no
+  ``event`` column.
+
+  Default:
+
+  ``array('name' => 0, 'event' => 1, 'date' => 2)``
+  
+``defaultEvent``
+  Text to use as event if there is no event column.
+
+  Defaults to ``Birthday``
+
+``firstLineIsHeader``
+  If the first line in the CSV is column header data
+
+  Defaults to ``true``
+
+``separator``
+  How columns are separated.
+
+  Defaults to ``,``
+
+
 LDAP server
 ===========
 *bdrem* can read birthdays and other events from persons in an LDAP server.
@@ -215,6 +273,10 @@ Dependencies
   - `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
 =======