add docblocks to all files, classes, methods and variables

[bdrem.git] / README.rst

diff --git a/README.rst b/README.rst
index 72f1074ec035b47a8b493caa4fbd7d6b89bd277a..2fcf4a23855c0cfb66547a90cbe9a6dbe4f22aeb 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,12 +1,29 @@
 *********************************
 bdrem - Birthday reminder by mail
 *********************************
-Birthday reminder that sends out mails (Text and HTML).
+Birthday reminder that sends out e-mails.
 
-It can also generate tables on your console/shell output and
-normal HTML pages.
+It can also generate ASCII tables on your console/shell and normal HTML pages.
 
 
+========
+Features
+========
+
+Data sources
+============
+- Any SQL database.
+
+  - Multiple date fields per record supported.
+- An LDAP server
+- `Birthday reminder <http://cweiske.de/birthday3.htm>` files (``.bdf``)
+
+Output formats
+==============
+- ASCII table
+- HTML
+- Email (text + HTML parts)
+
 
 =============
 Configuration
@@ -14,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
 =============
@@ -36,6 +57,20 @@ Use ``dblib`` in the DSN::
     dblib:host=192.168.1.1;dbname=Databasename
 
 
+============
+Dependencies
+============
+- PHP 5.3 or higher
+- PDO
+- PEAR packages:
+
+  - Console_CommandLine
+  - Mail
+  - Mail_mime
+  - Console_Table
+  - Net_LDAP2
+
+
 =======
 License
 =======