From bdf603a5ed7f6055d344a5c80a4f62e05b967af8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20Vold=C5=99ich?= <rbas.cz@gmail.com>
Date: Tue, 27 Aug 2024 16:51:06 +0200
Subject: [PATCH] Added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..af4f485
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+BCUP
+----
+
+Service for backup server configuration
+
+
+*Project is in development and does not have release yet*
+
+Start
+----
+
+Compile and run the project
+```shell
+cargo run
+```
+
+Connect to SurrealDB and run the following command
+
+```surrealdb
+CREATE rest_server CONTENT {
+    name: <future> {string::split(<string> id, ":")[1]},
+    domain: <future> {"rest-"+name+".hq.rosti.cz"},
+    volume: "/mnt/volume0",
+    directory: <future> {volume+"/rest-"+name},
+    rest_password: "sahTeecaezuN8ue8Ohb9faij4haiQuie",
+    repo_password: "ed9AhchoThahbex8bohgahng6eich9ji",
+    state: {
+        "required": "created",
+        "now": "pending"
+    }
+};
+```
+
+