From ceeed409a5e20db80b0dbf7ec0da357b773dd9f1 Mon Sep 17 00:00:00 2001
From: alphanoob1337 <alphanoob1337@users.noreply.github.com>
Date: Tue, 5 Mar 2019 03:10:07 +0100
Subject: [PATCH] Update README.md

Added description
---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index b0ac78a..e520118 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
 # postfixadmin_user_identities
 Roundcubemail plugin to have identities managed by postfixAdmin.
+
+# Installation and usage
+Unpack the files into `plugins/postfixadmin_user_identities`. Add `'postfixadmin_user_identities'` to your plugin array in your `config/config.inc.php`. I.e. like this:
+
+    $config['plugins'] = array('postfixadmin_user_identities');
+
+Then you can create your own configuration file specifiying the database connection as well as the structure of the table. Since the latter should be the same for every recent postfixAdmin setup, you probably only need to specify the database. So a very simple configuration file located under `plugins/postfixadmin_user_identities/config.inc.php` could look like this:
+
+    <?php
+    
+    // ----------------------------------
+    // SQL DATABASE
+    // ----------------------------------
+    // Similar to the $config['db_dsnw'] config variable, this is a
+    // database connection string (DSN) for read operations.
+    // For examples see http://pear.php.net/manual/en/package.database.mdb2.intro-dsn.php
+    $config['postfixadmin_user_identities_db_dsnr'] = 'mysql://<postfix-db-user>:<postfix-db-pass>@<postfix-db-hostname>/<postfix-db-name>';
+
+All other available configuration parameters can be found in `plugins/postfixadmin_user_identities/config.inc.php.dist`.
+
+**ENJOY**