From e840ead1eacf9a85fc5ac932f2530686c823ed9b Mon Sep 17 00:00:00 2001
From: KKlochko <KKlochko@protonmail.com>
Date: Wed, 21 Jun 2023 15:23:50 +0300
Subject: [PATCH] Update the README.

---
 README.org | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.org b/README.org
index 165e68e..d01c54c 100644
--- a/README.org
+++ b/README.org
@@ -4,6 +4,30 @@ bot backend.
 
 It uses [[https://docs.dots.live/][Dots Platform Clients API]].
 
+* Setup
+- clone this repository.
+- copy =.env.example= and save as =.env=.
+- change update the information about the database and the dots api =.env=:
+  =postgres= is same name of the service in =docker-compose.yaml=.
+  Example:
+  #+BEGIN_SRC toml
+    DB_CONNECTION=pgsql
+    DB_HOST=postgres
+    DB_PORT=5432
+    DB_DATABASE=your_database
+    DB_USERNAME=another_user
+    DB_PASSWORD=secure_password
+
+    DOTS_BASE_URL=https://dotsdomain.test
+    DOTS_API_TOKEN=your_api_token
+    DOTS_API_ACCOUNT_TOKEN=your_api_account_token
+    DOTS_API_AUTH_TOKEN=your_api_auth_token
+  #+END_SRC
+- if you change the database information in =.env=, then it must be changed in =dots-bot-api/docker/postgres/.env=.
+- run =sudo docker-compose up -d= in the project folder.
+- run =sudo docker ps= to see that =dots-bot-api-nginx= bind your host's port with 80.
+- Now you can setup [[https://gitlab.com/KKlochko/dots-matrix-bot][dots-matrix-bot]].
+
 * Author
 Kostiantyn Klochko (c) 2023