diff --git a/README.md b/README.md index c9d29a6..7361018 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,19 @@ Simple GUI menu aimed at touchscreens that is supposed to provide quick actions for the user. [![builds.sr.ht status](https://builds.sr.ht/~michalr/menu.svg)](https://builds.sr.ht/~michalr/menu?) + +## Configuration + +Configuration is done using a JSON file. See [`example_config.json`](./example_config.json) for details. + +## Available actions + +### `MSG` + +Shows a message `action_message` for `action_param` number of seconds. + +`action_param` must be an integer. + +## `GET` + +Performs a `GET` on the `action_param` URL while displaying `action_message`.