From cca4dce96142d2b2d04b419bd7500e3841262235 Mon Sep 17 00:00:00 2001
From: simon <simon.tretter@hokify.com>
Date: Sun, 23 Feb 2020 20:44:55 +0100
Subject: [PATCH] fix: docs

---
 README.md | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index ce679c8..9254412 100644
--- a/README.md
+++ b/README.md
@@ -55,14 +55,14 @@ you need:
 2.  Optional: Create your own SSL certificate (e.g. self signed via npm run create-certificate)
 3.  Check config.js and adapt to your needs
 
-- configure authentication e.g. for LDAP
+- configure authentication:
+set authenticaiton to one of the provided authenticators.
 
 ```js
 var config = {
 	// ....
-	authentication: 'ldap',
+	authentication: 'GoogleLDAPAuth',
 	authenticationOptions: {
-		url: 'ldap://127.0.0.1:1636',
 		base: 'dc=hokify,dc=com'
 	}
 };
@@ -85,6 +85,20 @@ see config.js in root
 
 google ldap optimized authenticiation implementaiton
 
+```typescript
+interface IGoogleLDAPAuthOptions {
+	/** base DN
+	 *  e.g. 'dc=hokify,dc=com', */
+	base: string;
+	/** tls options
+	 * e.g. {
+			key: fs.readFileSync('ldap.gsuite.hokify.com.40567.key'),
+			cert: fs.readFileSync('ldap.gsuite.hokify.com.40567.crt')
+		} */
+	tlsOptions: tls.TlsOptions;
+}
+```
+
 #### LDAP
 
 ldap authentication