add readme

Signed-off-by: Mirror <voice@magicalmirro.red>
This commit is contained in:
Mirror 2022-06-17 15:52:00 +03:00
parent ce3d8375d2
commit 39bd86991e
Signed by: voice
GPG Key ID: C2DCB75FD46475D2

29
README.md Normal file
View File

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