From 3bf3b9e1cb806d75961ae1b29823187e887b7015 Mon Sep 17 00:00:00 2001
From: Marco Lettere <marco.lettere@nubisware.com>
Date: Fri, 30 Sep 2022 15:24:26 +0200
Subject: [PATCH] Aggiornare 'README.md'

---
 README.md | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 69 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8b75a6c..2189451 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,71 @@
 # conductor_playground
 
-A playground for experimenting, developing and testing Netflix OSS Conductor based workflows.
\ No newline at end of file
+A playground for experimenting, developing and testing Netflix OSS Conductor based workflows.
+
+# Useful information
+
+## launch playground
+```docker-compose -f stack-playground.yaml up```
+
+## Upload workflow with:
+Put mioworkflow.json into workflows dir, then:
+
+```./upload-workflow.sh mioworkflow```
+
+## Delete workflow with:
+If 1 is the version to remove and mioworkflow is the name given to the workflow
+
+```./delete-workflow.sh mioworkflow/1```
+
+## Useful links
+
+Conductor REST API:
+
+```http://localhost:8080/api```
+
+Access UI:
+
+```http://localhost:5000/```
+
+Official Site:
+
+```https://conductor.netflix.com/```
+
+## Task documentation
+
+pyrest task inputParameters are configured like this:
+
+```
+{
+    "method" : "POST",
+    "url" : "http://...."
+    "headers" : {
+        "Authorization" : "...",
+        "Content-Type" : "....",
+        "Accept" : "...",
+        ...
+    },
+    "params" : { // Query string parameters
+
+    },
+    "body" : {  //either a map of form-parameters or a JSON structure or a string body
+
+    },
+    "expect" : [200,409], // Default is 20x
+    "fail" : true|false   #if failure should be avoided at all. If set to true the task succeeds independently of the HTTP Status
+}
+```
+
+pyrest output is as follows:
+
+```
+{
+    "body" : //the response body possibly parsed to JSON if Accept is set to "application/json" or response contains a mime-type indication of "applciation/json"
+    "headers" : {
+        // a map containing the response headers
+    },
+    "status" : 200,
+    "readon" : "OK"
+}
+```
+