From 25916e1d929ecc681c50f7efe633065eb9abbcbc Mon Sep 17 00:00:00 2001
From: jsdio <jsdio@jsdio.ru>
Date: Mon, 5 Jun 2023 16:56:33 +0300
Subject: [PATCH] =?UTF-8?q?=D0=9D=D0=B0=D1=81=D1=82=D1=80=D0=BE=D0=B9?=
 =?UTF-8?q?=D0=BA=D0=B0=20readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index af6d464..3e38155 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
-# ips_etl
+# IPS ETL
+## Описание
 
+Этот проект представляет собой ETL процесс, который собирает данные из API и передаёт их на принимающую сторону. 
+## Установка и настройка
+### Предварительные требования
+- Docker
+- Docker-compose
+- Git
+
+### Шаги для запуска
+1. Клонируйте репозиторий на вашу машину при помощи команды `git clone https://git.jsdio.ru/jsdio/ips_etl.git`.
+2. Переименуйте файл `.env.dist` в `.env`.
+3. Откройте файл `.env` и замените значения переменных на свои:
+    - `API_HOST`: адрес хоста API.
+    - `API_TOKEN`: токен API.
+    - `IBLOCKS`: список номеров инфоблоков через запятую без пробелов.
+    - `DESTINATION_HOST`: адрес хоста назначения.
+    - `DESTINATION_PORT`: порт назначения.
+    - `DESTINATION_PROTOCOL`: протокол назначения (http или https).
+    - `LAST_ID`: последний успешно обработанный ID.
+4. После настройки переменных, запустите проект при помощи docker-compose командой `docker-compose up -d`.
\ No newline at end of file