From 69bd88787831e976afe6ec30e308725c5cd45e24 Mon Sep 17 00:00:00 2001 From: Redume Date: Mon, 30 Sep 2024 14:07:50 +0300 Subject: [PATCH] update readme --- README.md | 55 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 32 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index e495c1f..f20b7fd 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # Shirino -## Что это? -Telegram-бот который выводит курс валюты используя DuckDuckGO и [CoinAPI](https://www.coinapi.io/). - -https://t.me/Shirino_bot +> [!NOTE] +> Telegram-бот который выводит курс валюты используя DuckDuckGO и [CoinAPI](https://www.coinapi.io/). +> +> https://t.me/shirino_bot ## Хочу запустить +
+ Получите токен бота в телеграме и токен CoinAPI. -Вставьте в файл `.env` в формате: +Вставьте в файл `config.yaml` в формате: ```yaml coinapi_keys: @@ -17,26 +19,33 @@ coinapi_keys: telegram_token: Токен Telegram-бота ``` -В .env файл ещё можно такие переменные добавить: +В `config.yaml` файл ещё можно такие переменные добавить: ```yaml -debug: false или true, включает отладочные логи -timeout: таймаут для библиотеки requests, в секундах (2 по дефолту) +debug: false # включает отладочные логи (false/true) +timeout: 2 # таймаут для библиотеки requests, в секундах (2 по дефолту) ``` -## Хочу сделать пулл-реквест -Ставьте pylint и mypy для статической проверки кода. -Конфиги уже есть в репозитории. -После проверок можете открывать PR. +
-## Почему энв для CoinAPI -- список? -Можно получить несколько ключей на разные почтовые ящики -и все ключи вписать в список: -```yaml -coinapi_keys: - - key1 - - key2 - - etc. -``` +## Хочу сделать Pull Request. +
+ Ставьте pylint и mypy для статической проверки кода. + Конфиги уже есть в репозитории. + После проверок можете открывать PR. +
-Если вдруг один из них будет заблокирован по рейтлимиту, -бот автоматически переключится на следующий (token rotation). +## Почему конфиг для CoinAPI - список? +
+ Можно получить несколько ключей на разные почтовые ящики + и все ключи вписать в список: + + ```yaml + coinapi_keys: + - key1 + - key2 + - etc. + ``` + + Если вдруг один из них будет заблокирован по рейтлимиту, + бот автоматически переключится на следующий (token rotation). +
\ No newline at end of file