added README

README.md

@@ -0,0 +1,30 @@
+# dovecot
+
+## Parameters and defaults
+
+All configuration is to be placed inside the `dovecot` dict.
+
+```
+# Array of protocols to enable, by default 'imaps' and 'sieve' are enabled.
+# Can be 'imap', 'imaps', 'pop3', 'pop3s', 'sieve'
+  protocols: ['imaps', 'sieve' ]
+
+# Array of IPs to bind on. By default we bind wildcard IPv4 and IPv6
+  listen: ["*", "::"]
+
+# Authentication mechanisms to support, for options see https://doc.dovecot.org/configuration_manual/authentication/authentication_mechanisms/
+  auth_mechanisms: ["plain", "login"]
+
+# Array of users if dovecot should handle users in a db. Not usable if you enable ldap.
+# Each user is a dict, for options see *userdict* below
+  user: []
+```
+
+**userdict**
+```
+# username
+name: "name"
+
+# clear text password
+password: "pw"
+```