From 87459fce42e0f067479e600a08d904100b062249 Mon Sep 17 00:00:00 2001
From: ostiwe <ostiwe@icloud.com>
Date: Mon, 21 Jul 2025 00:04:55 +0300
Subject: [PATCH] feat: Added README

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89e847c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Status page
+
+#### How to run server:
+
+```shell
+./status server 
+```
+
+#### How to run documentation server:
+
+```shell
+./status server-docs 
+```
+
+#### Example `--help` command:
+
+```
+0.0.1
+Usage: status <command> [<args>]
+
+Options:
+  --help, -h             display this help and exit
+  --version              display version and exit
+
+Commands:
+  server                 Start the api server
+  server-docs            Generate documentation for api server
+```
+
+## Configuration
+
+To configure application follow these table of Env:
+
+| Name          | Example        | Definition |
+|---------------|----------------|------------|
+| DATABASE_HOST | localhost      | -          |
+| DATABASE_PORT | 5432           | -          |
+| DATABASE_USER | someUserName   | -          |
+| DATABASE_PASS | strongPassword | -          |
+| DATABASE_DB   | statuspage     | -          |
+| DATABASE_TZ   | Europe/Moscow  | -          |
\ No newline at end of file