Create .env.example and finaly create README.md

This commit is contained in:
Stefano Assenzo 2022-09-13 13:32:48 +02:00
parent 6472c656de
commit 74dd07c211
3 changed files with 32 additions and 1 deletions

3
.env.example Normal file
View File

@ -0,0 +1,3 @@
BOT_TOKEN = ""
PASSWORD_MONGODB = ""
URL_MONGODB = ""

29
README.md Normal file
View File

@ -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
```

View File

@ -1 +0,0 @@