Add README.md

README.md

+FEUDAL Scripts
+=
+
+FEUDAL scripts are executed by a FEUDAL client to facilitate the customized deployment process 
+of an arbitrary service. 
+
+They use the JSON encoding for input and output. The specific formats are outlined below.
+
+
+Input format
+-
+
+{
+    "state_target": "deployed" or "not_deployed",
+    
+    
+    "user": {
+        "userinfo": <OpenID Connect userinfo as json dict>
+    },
+    
+    // The credentials from the user, which need to be deployed
+    // The dict maps a credential type to a list of credentials of this type.
+    "credentials": {
+        "ssh_key": [
+            {
+                "name": "unity_key",
+                "value": "ssh-... ..."
+            }
+        ]
+    },
+    
+    // Answers to a previously requested questionnaire
+    "questionnaire": {
+        "question_name": "user answer to this question"
+    }
+}
+
+
+
+Output format
+-
+
+{
+    "state": "deployed" or "not_deployed" or "failed" or "rejected" or "questionnaire",
+    
+    
+    "message": "<message for the user, in case state is 'failed' or 'rejected'>",
+    
+    // In case we need more info from the user: set state to "questionnaire" and put 
+    // questions in this dictionary.
+    // The user can answer these questions (and we will receive the answers some input in the future) 
+    "questionnaire": {
+        "question_name": "question"
+    },
+    
+    // additional credentials and instructions, the user needs to access the service
+    // an example would be the user name of the provisioned user.
+    "credentials": {
+        "key": "value"
+    }
+}