From 4e00e86ac31d4f8128cc1d5308330791874beada Mon Sep 17 00:00:00 2001
From: Vladimir Semenov <33404130+subatiq@users.noreply.github.com>
Date: Thu, 2 Mar 2023 13:56:46 +0300
Subject: [PATCH] Update README.md

---
 README.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 73a1284..fafec1d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,37 @@
-# service-template
\ No newline at end of file
+# Daily hero
+
+Gitlab (😰) + SMTP версия [gdml/daily-hero](https://github.com/gdml/daily-hero) by [@f213](https://github.com/f213)
+
+Ежедневная рассылка с открытыми и закрытыми задачками за день.
+
+--- 
+
+## Как работает
+
+У нас (в Инвиан) разворачиваем в Яндекс облаке как serverless container с триггером на 18:00 каждый день.
+
+Если не было обновлений в задачках за день, то ничего не присылается. Удобно вылавливать трудоголиков на выходных.
+
+Отправляет сообщение всем, кто зарегистрирован в инстансе гитлаба. 
+
+**!!! На облачном не тестировалось, скорее всего отправит вообще всем пользователям гитлаба. !!!**
+
+## Настройка
+
+Настраивается через переменные окружения:
+
+```
+GITLAB_URL=<URL Gitlab инстанса>
+GITLAB_TOKEN=<Gitlab токен с read_api доступом>
+EMAIL=<почта, с которой будет рассылаться сообщение>
+EMAIL_PASSWORD=<пароль от почты или "пароль приложения" в яндекс почте>
+SMTP_SERVER=<что-то вроде smtp.yandex.ru>
+SMTP_PORT=<что-то вроде 465>
+ENV=<В DEBUG окружении не будет отсылать всей команде, в любом другом будет>
+DEBUG_EMAIL=<тестовая почта, в случае, если ENV=DEBUG>
+BLACKLIST=<список через | почт, на которые не отправлять ничего>
+```
+
+## Отписка
+
+Для отписки можно добавить "hero" в графу "Pronouns" профиля на гитлабе.