Start working on user folder

1 files changed, 18 insertions, 0 deletions

diff --git a/user/README.md b/user/README.md
new file mode 100644
index 0000000..f59e576
--- /dev/null
+++ b/user/README.md
@@ -0,0 +1,18 @@
+## User-specific config
+You can create `config.json` file in this folder to override `default-config.json` options.
+All root config fields are optional to override, so you need to create only what you want to change.
+File example:
+```json
+{
+	"channelName": "-=SuperChannel=-",
+	"videoLimit": 10,
+}
+```
+## User-specific resources
+You can patch any file you want in project `res/` by creating `user/res/sameName` files.
+For example `user/res/index.html` or `user/res/css/custom.css`.
+You can also add any new files.
+## Other files here
+- `state.json` - saved state of latest server session (messages, videos, video time).
+- `logs/` - latest 10 logs. You can change count in config.
+- `crashes/` - folder with latest error logs, when the server had to restart itself.