From 490aad08e322c60df12afdde7ecf308bb18dbbbc Mon Sep 17 00:00:00 2001 From: Andrei Jiroh Eugenio Halili Date: Tue, 18 Aug 2020 20:00:41 +0800 Subject: [PATCH] [repo] Update the README As per the previous commit, committing Telegram API app ID, app hash, and Bot API token is a REALLY BAD IDEA. Signed-off-by: Andrei Jiroh Eugenio Halili --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7a6551..7ed912a 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ To setup a project using BotBase, follow this step-by-step guide (assuming `pip` - Open a terminal and type `git clone https://github.com/nocturn9x/BotBase` - `cd` into the newly created directory and run `python3 -m pip install -r requirements.txt` -- Once that is done, open the `BotBase/config.py` module with a text editor and start changing the default settings -- The first thing you might want to do is change the `API_ID`, `API_HASH` and `BOT_TOKEN` global variables. Check [this page](https://my.telegram.org/apps) and login with your telegram account to create an API_ID/API_HASH pair. For the bot token, just create one with [BotFather](https://telegram.me/BotFather) +- Once that is done, copy `BotBase/config.example.py` as `config.py` and edit your `config.py` module with a text editor and start changing the default settings +- The first thing you might want to do is change the `API_ID`, `API_HASH` and `BOT_TOKEN` global variables. Check [this page](https://my.telegram.org/apps) and login with your Telegram account to create an API_ID/API_HASH pair by registering a new application. For the bot token, just create one with [BotFather](https://telegram.me/BotFather). **Note**: The configuration file is still a python file and when it will be imported any python code that you typed inside it will be executed, so be careful! If you need to perform pre-startup operations it is advised to do them in the `if __name__ == "main":` block inside `bot.py`, before `bot.start()`