From 630e814da03045c51ec6e515e7912c77399c407a Mon Sep 17 00:00:00 2001
From: Hannes Braun <hannes.braun@slub-dresden.de>
Date: Tue, 21 Mar 2023 12:38:13 +0100
Subject: [PATCH] Updated README.md for first release

---
 README.md | 31 ++++++++++++++++++++++++++-----
 1 file changed, 26 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 7118bfb..e3b76b2 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,37 @@
-# role-create-user
+# role-manage-users
 
 ## Name
-Choose a self-explaining name for your project.
+Create, configure and/or delete users.
 
 ## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+An ansible role to to manage the users of your linux installation. It is capable to create, configure and delete users. Define which groups the user shall be an, either exclusive oder additional.
 
 ## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+Either refer to the role via a requirements.yml, dependecies inside a meta.yml or via cloning the repository.
+
+**Requirements.yml - Example**
+
+```yaml
+---
+roles:
+  - name: role-manage-user
+    src: https://25_read_ansible_roles:glpat-5Ci385Nui9Uvyy8dQcuC@git.slub-dresden.de/ansible/referat25/role-manage-users.git
+    scm: git
+    version: v1.0
+```
+
+```bash
+ansible-galaxy install -r requirements.yml
+```
 
 ## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+Provide valid variables and include role inside your playbook.
+
+For variables see `defaults/main.yml`.
 
 ## License
+
 For open source projects, say how it is licensed.
-- 
GitLab