diff --git a/README.md b/README.md index 071bc10..17e6b45 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,4 @@ -# Shirino - > [!NOTE] -> Telegram-бот который выводит курс валюты используя DuckDuckGO и [Kekkai](https://github.com/Redume/Kekkai). -> -> https://t.me/shirino_bot - -## Хочу запустить -
- -Вставьте в файл `config.yaml` в формате: - -```yaml -telegram_token: Токен Telegram-бота -``` - -В `config.yaml` файл ещё можно такие переменные добавить: -```yaml -debug: false # включает отладочные логи (false/true) -timeout: 2 # таймаут для библиотеки requests, в секундах (2 по дефолту) -``` - -
- -## Хочу сделать Pull Request. -
- Ставьте pylint и mypy для статической проверки кода. - Конфиги уже есть в репозитории. - После проверок можете открывать PR. -
+> Shirino - a simple bot for converting fiat and cryptocurrency exchange rates. Using DuckDuckGo and [Kekkai](https://github.com/Redume/Kekkai). +> +> https://t.me/shirino_bot \ No newline at end of file