From b2da06b2cc8a77acf505bd01fd874a5660730b5c Mon Sep 17 00:00:00 2001
From: Martin Pietsch <martin.pietsch@tu-dresden.de>
Date: Thu, 1 Aug 2019 12:08:15 +0200
Subject: [PATCH] added documentation

---
 README.md | 71 +++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 46 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index 225dd44..e911c8c 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,59 @@
-Role Name
-=========
+Description
+===========
 
-A brief description of the role goes here.
+This role is the top level package of all auth categorised software and does not provide a special software product.
 
 Requirements
-------------
-
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
-
-Role Variables
---------------
-
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
-
-Dependencies
-------------
+============
+
+Variables
+----------
+
+- development note: Define these variables in the defaults/main.yml file of your sub-role.
+
+* auth_permitted_users:
+  * description:
+    * This option contains a list of usernames that are allowed to access the system(s).
+  * default: []
+  * example: auth_permitted_users: ["user1", "user2"]
+
+* auth_permitted_groups:
+  * description:
+    * This option contains a list of groupnames that are allowed to access the system(s).
+  * default: []
+  * example: auth_permitted_users: ["group1", "group2"]
+
+* auth_denied_users:
+  * description:
+    * This option contains a list of usernames that are locked for the access to the system(s).
+  * default: []
+  * example: auth_permitted_users: ["user1", "user2"]
+
+* auth_denied_groups:
+  * description:
+    * This option contains a list of groupnames that are locked for the access to the system(s).
+  * default: []
+  * example: auth_permitted_users: ["user1", "user2"]
+    
+Processes
+=========
 
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+main
+----
 
-Example Playbook
-----------------
+1. NOP
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+configure
+---------
 
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
+1. NOP
 
 License
--------
+=======
 
 BSD
 
-Author Information
-------------------
+Contributors
+============
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+- Martin Pietsch (martin.pietsch@tu-dresden.de)
-- 
GitLab