From abbaec38da2a1c95078507d863cf0b3c573a4ce7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20Rudowicz?= <michal.rudowicz@fl9.eu>
Date: Tue, 10 Sep 2024 16:25:48 +0200
Subject: [PATCH] Added some simple documentation into README

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

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`.