update readme
[auerswald-compact-ldap.git] / README.rst
index 3494748eabf86d8aec499855464a25793533c029..582017c16ba3996e0363b59101834856defee529 100644 (file)
@@ -2,7 +2,22 @@
 Auerswald COMpact LDAP
 ======================
 
-Generates all phone numbers from LDAP and generates a ``.csv`` that
+Fetches all phone numbers from LDAP and generates a ``.csv`` that
 can be imported into the COMpact 3000 address book.
+Also provides a script to upload that file to the COMpact 3000.
 
 
+
+Configuration
+=============
+Copy ``config.php.dist`` to ``config.php`` and adjust it.
+
+
+Generating the CSV
+==================
+Running ``ldap2csv.php`` will put the generated CSV out to ``stdout``.
+
+
+Uploading to COMpact
+====================
+FIXME