From 9e4d78071c24e38ed56db6b1fa35c8d1d8ef7933 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rg=20Sachse?= <Joerg.Sachse@slub-dresden.de>
Date: Fri, 22 Jan 2021 15:19:44 +0100
Subject: [PATCH] doc: describe invocation and document details of
 Vault/variable use

---
 README.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1153edc..8a8bb10 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ To deploy this role to a managed host, the following software must be installed
 ## Quick start
 
 ```
-        ansible-playbook site.yml -i <INVENTORY_FILE> --limit <HOSTNAME>
+        ansible-playbook site.yml [-i <INVENTORY_FILE>] [--limit <HOSTNAME>] [-u <USERNAME] [-b]
 ```
 
 ## General Ansible usage
@@ -63,12 +63,16 @@ For more help with ansible-playbook, use the `--help` flag.
 
 ## Testing the role
 
-Tests have been implemented using the Molecule framework. The details on using the test suite are described below `molecule/`.
+Tests have been prepared/implemented using the Molecule framework. The details on using the test suite are described below `molecule/`.
 
 ## Variables
 
 Many variables have been "hidden" in encrypted Ansible Vaults. For security reasons, these Vaults are maintained in a separate private internal repository of SLUB's Git. However, in order to better understand the data within the vaults, you can find `\*.vault.example` files below the `vars/` directory.
 
+If you work outside of SLUBArchive and have no access to the vault repository, make sure to put the necessary vaults in the expected paths at `../ansible_vaults/<ROLENAME>/`.
+
+You also might want to update the values of the variables in `vars/main.yml` to match your requirements.
+
 ## git configuration
 
 Just run the `setup_gitconfig.sh` script that comes with the repo to correctly setup all necessary local Git configurations.
-- 
GitLab