license and installation/dependency information

[auerswald-callnotifier.git] / README.rst

diff --git a/README.rst b/README.rst
index daf94e24b085105f8a30b8a2eedf82527b52862c..f4a7038079e3b02db5d695397de15ee7cecbf538 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -14,6 +14,24 @@ caller location city names via OpenGeoDb.
 
 .. contents::
 
+
+============
+Installation
+============
+
+1. Clone the git repository
+2. Install dependencies
+3. Configure the tool
+4. Run ``./callnotifier.php``
+
+
+Dependencies
+============
+- PEAR's Console_CommandLine package
+- PEAR's Net_LDAP2 package for LDAP name resolution
+- curl for the dreambox notifier
+
+
 =============
 Configuration
 =============
@@ -118,6 +136,12 @@ This is a problem with PHP since pcntl_signal handling and blocking sockets
 do not work together. The signal will not be handled.
 
 
+=======
+License
+=======
+Auerswald callnotifier is licensed under the terms of the GPLv3 or later.
+
+
 ======
 Source
 ======