From 39bd86991ec187def9e1bb394ff3c7c18b3c2ba9 Mon Sep 17 00:00:00 2001
From: Mirror <voice@magicalmirro.red>
Date: Fri, 17 Jun 2022 15:52:00 +0300
Subject: [PATCH] add readme

Signed-off-by: Mirror <voice@magicalmirro.red>
---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..985d166
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+### What is this?
+This is a primitive application for streaming video files to Smart-TVs or any device with a browser, with a simple control of the list of these files.
+
+### Configuration example
+```
+# config.yaml
+# just title of the webpage
+application_name: "My Marketing Videos"
+
+# path where files will be stored
+data_directory: "web"
+
+# ip address to bindgo
+listen_address: ":8000"
+admin_user: "admin"
+admin_password: "abcd@1234"
+
+# increasing this number will cause active clients to reload the page. Useful for hot-fixing client code.
+generation: 5
+```
+
+### -help option
+```
+videopage:
+  -config string
+        Path to the configuration file (default "config.yaml")
+  -rescan
+        Rescan the data direcory
+```