README update.

2015-10-14 17:33:28 +02:00
parent 84fe9b0d16
commit d47f9d1634
1 changed files with 18 additions and 2 deletions
--- a/README.rst
+++ b/README.rst
@@ -1,2 +1,18 @@
-# modoboa-installer
-An installer for Modoboa
+modoboa-installer
+=================
+
+An installer for Modoboa.
+
+.. warning::
+
+   This tool is still in beta stage, it has been tested on Debian
+   Jessie (8) only.
+
+Usage::
+
+  $ git clone https://github.com/modoboa/modoboa-installer
+  $ cd modoboa-installer
+  $ sudo ./run.py
+
+To customize the installation, look at the ``installer.cfg`` file.
+