Added basic readme file

This commit is contained in:
Dávid Kaya
2017-02-03 14:57:12 +01:00
committed by GitHub
parent 001093d3bb
commit 302d4c17b6

73
README.md Normal file
View File

@@ -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
}
}
```