Redume/Shirino
1
0
Fork 0
mirror of https://github.com/Redume/Shirino.git synced 2025-02-04 09:58:57 +03:00
Code Issues Projects Releases Packages Wiki Activity

chore(readme): Updated the readme, removed unnecessary stuff and wrote a new description

Browse source
This commit is contained in:
Данил 2025-01-11 22:14:27 +03:00
parent 7972e16b28
commit 7c3f289bd6
1 changed files with 3 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,30 +1,4 @@
# Shirino
> [!NOTE]
> Telegram-бот который выводит курс валюты используя DuckDuckGO и [Kekkai](https://github.com/Redume/Kekkai).
> 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
## Хочу запустить
<details>
Вставьте в файл `config.yaml` в формате:
```yaml
telegram_token: Токен Telegram-бота
```
В `config.yaml` файл ещё можно такие переменные добавить:
```yaml
debug: false # включает отладочные логи (false/true)
timeout: 2 # таймаут для библиотеки requests, в секундах (2 по дефолту)
```
</details>
## Хочу сделать Pull Request.
<details>
Ставьте pylint и mypy для статической проверки кода.
Конфиги уже есть в репозитории.
После проверок можете открывать PR.
</details>