From 302d4c17b6e7763c26c327b998a7345b8d3efcb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?D=C3=A1vid=20Kaya?= Date: Fri, 3 Feb 2017 14:57:12 +0100 Subject: [PATCH] Added basic readme file --- README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4055a77 --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +# Testa + +TODO: General info + +# Building + +Run following commands in terminal +``` +$ qmake +$ make +``` + +# Usage + +Testa connects (by default) to ```ws://localhost:12345```. +Testa accepts _Actions_ in following format: +```js +{ + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "parameters": { + "type": "object", + "properties": {} + } + }, + "required": [ + "action", + "parameters" + ] +} +``` + +It can perform following _Actions_: + +## Load URL + + +```js +{ + "action": "loadUrl", + "parameters": { + "url": "http://www.ysoft.com" + } +} +``` + +## Show notification + + +```js +{ + "action": "showNotification", + "parameters": { + "title": "Notification title", + "message": "Notification message" + } +} +``` + +## Set progress (currently only Mac OS X) + + +```js +{ + "action": "setProgress", + "parameters": { + "value": 0.5 + } +} +```