From fe9b451d5c67d2c8bf08b03aaeb180cc2858f458 Mon Sep 17 00:00:00 2001 From: Ali Askari Date: Sat, 28 Dec 2024 21:20:28 +0330 Subject: [PATCH] add README --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b50bf06 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Bonbast2TG + +Bonbast2TG is a project that fetches exchange rates from Bonbast and sends updates to a Telegram channel. + +## Features + +- Fetches exchange rates from Bonbast +- Sends updates to a specified Telegram channel +- Configurable update intervals + +## Installation + +1. Clone the repository: + ```sh + git clone https://github.com/yourusername/bonbast2tg.git + ``` +2. Navigate to the project directory: + ```sh + cd bonbast2tg + ``` +3. Install the required dependencies: + ```sh + pip install -r requirements.txt + ``` + +## Configuration + +1. Create a `.env` file in the project directory with the following content: + ```env + TELEGRAM_BOT_TOKEN=your_telegram_bot_token + TELEGRAM_CHAT_ID=your_telegram_chat_id + ``` + +## Usage + +Run the script to start fetching exchange rates and sending updates: +```sh +python main.py +```