diff --git a/README.rst b/README.rst index 0ef0992..18865a1 100644 --- 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. +