From 3f853066d5be64f064700c2c16943432d3b5af07 Mon Sep 17 00:00:00 2001
From: David Kaufmann <david.kaufmann@student.tuwien.ac.at>
Date: Sun, 25 Nov 2018 20:28:32 +0100
Subject: [PATCH] add readme, rename option

---
 camunda-overlay/README.md  | 16 ++++++++++++++++
 camunda-overlay/camunda.py |  2 +-
 2 files changed, 17 insertions(+), 1 deletion(-)
 create mode 100644 camunda-overlay/README.md

diff --git a/camunda-overlay/README.md b/camunda-overlay/README.md
new file mode 100644
index 0000000..aef79ec
--- /dev/null
+++ b/camunda-overlay/README.md
@@ -0,0 +1,16 @@
+Run ```./camunda.py``` to just deploy the process.
+
+Flags:
+
+```--autoclick 1```: will deploy the process and run it with three terms.
+Result should be available in Camunda Tasklist -> All Tasks
+
+```--no-deploy```: do not deploy the process, probably only useful with the autoclick-flag
+
+```--no-cleanup```: do not remove old deployments, keep tasks running (might be confusing if there are multiple deployments)
+
+Default login:
+
+URI: http://localhost:8080/camunda/
+User: demo
+Pass: demo
diff --git a/camunda-overlay/camunda.py b/camunda-overlay/camunda.py
index da4e5d7..8ecaa0c 100755
--- a/camunda-overlay/camunda.py
+++ b/camunda-overlay/camunda.py
@@ -79,7 +79,7 @@ def submit_terms(terms):
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()
-    parser.add_argument('--deploy', dest='deploy', default=True, action='store_false', help="Do deployment step")
+    parser.add_argument('--no-deploy', dest='deploy', default=True, action='store_false', help="Do not run the deployment step")
     parser.add_argument('--no-cleanup', dest='cleanup', default=True, action='store_false', help="Initial deploy does not need cleanup")
     parser.add_argument('--autoclick', dest='autoclick', type=int, default=0, help="How many steps to autoclick")
     args = parser.parse_args()
-- 
2.43.0