From 74dd07c211d4bf3107a2dedb1079f6f37083ddfa Mon Sep 17 00:00:00 2001 From: Stefano Assenzo Date: Tue, 13 Sep 2022 13:32:48 +0200 Subject: [PATCH] Create .env.example and finaly create README.md --- .env.example | 3 +++ README.md | 29 +++++++++++++++++++++++++++++ mydata/readme.txt | 1 - 3 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 .env.example create mode 100644 README.md delete mode 100644 mydata/readme.txt diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..cd534b8 --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +BOT_TOKEN = "" +PASSWORD_MONGODB = "" +URL_MONGODB = "" \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8e0e61 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Epic Games Notifier Telegram + +**A Telegram bot to notify via Telegram when there is a new free game in the Epic Games Store.** +- Find it on Telegram as [Telegram bot](https://t.me/EpicNotifier_bot) + +# To Do +- [ ] Write documentation +- [ ] When the bot restarts automatically it starts looking for games again. +- [ ] Create logo + +# Installation + +- Install libraries + +```console +pip install -r requirements.txt +``` + +- Clone this repository +```console +git clone https://github.com/assenzostefano/epic-games-notifier-telegram +``` + +- Change name file .env.example to .env and insert the data is required. + +- Execute the bot +```console +python main.py +``` \ No newline at end of file diff --git a/mydata/readme.txt b/mydata/readme.txt deleted file mode 100644 index 8b13789..0000000 --- a/mydata/readme.txt +++ /dev/null @@ -1 +0,0 @@ -