From 9267855a2db1b7238f1b2871755ca64d80016155 Mon Sep 17 00:00:00 2001
From: Illya Marchenko <stuzer05@stuzer.link>
Date: Thu, 11 Apr 2024 12:26:42 +0300
Subject: [PATCH] Update README.md

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e3e7a22..3f7c434 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
-Telegram bot to notify about new EpicGames free game promotions
+# EpicGames free game promotions for Telegram
+
+Bot queries EpicGames website once a day for free games. Bot tracks already seen games, so you won't receive telegram notification twice for the same game.
+
+## Configuration
+
+clone this repository
+
+setup cronjob for `run.php`
+```sh
+0 10 * * * /usr/bin/php /opt/scripts/epicgames_promotions_bot/run.php
+```
+
+in `run.php` configure telegram BOT_KEY and list telegram user ids to send notifications for
+```php
+$config = [
+  'tg_bot_key' => 'BOT_KEY',
+  'tg_chat_ids' => [
+	'111111111', // user1
+	'222222222', // user2
+  ],
+];
+
+```
\ No newline at end of file
-- 
2.45.2