add docblocks to all files, classes, methods and variables

[bdrem.git] / README.rst

diff --git a/README.rst b/README.rst
index 2407b97549bfd366e9ffb37f5a711db046a83a84..2fcf4a23855c0cfb66547a90cbe9a6dbe4f22aeb 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -12,9 +12,11 @@ Features
 
 Data sources
 ============
-- Any SQL database
+- Any SQL database.
+
+  - Multiple date fields per record supported.
 - An LDAP server
-- Birthday reminder files (``.bdf``)
+- `Birthday reminder <http://cweiske.de/birthday3.htm>` files (``.bdf``)
 
 Output formats
 ==============
@@ -29,6 +31,10 @@ Configuration
 Copy ``data/bdrem.config.php.dist`` to ``data/bdrem.config.php`` and
 adjust it to your liking.
 
+When running the ``.phar``, extract the configuration file first::
+
+    $ php dist/bdrem-0.1.0.phar config > bdrem-0.1.0.phar.config.php
+
 
 MS SQL server
 =============
@@ -57,6 +63,7 @@ Dependencies
 - PHP 5.3 or higher
 - PDO
 - PEAR packages:
+
   - Console_CommandLine
   - Mail
   - Mail_mime