mirror of
https://github.com/Redume/Shirino.git
synced 2024-11-21 15:56:22 +03:00
Updated readme, license notice
This commit is contained in:
parent
df17a74e5f
commit
50ffdbc24a
2 changed files with 23 additions and 1 deletions
2
LICENSE
2
LICENSE
|
@ -1,4 +1,4 @@
|
|||
Copyright (c) 2023 Redume
|
||||
Copyright (c) 2023 Redume, DarkCat09 (Chechkenev Andrey)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
22
README.md
22
README.md
|
@ -1,2 +1,24 @@
|
|||
# Shirino
|
||||
|
||||
## Что это?
|
||||
Бот для телеграма. Выводит курс валют.
|
||||
https://t.me/Shirino_bot
|
||||
|
||||
## Хочу запустить
|
||||
Получите токен бота в телеграме и токен CoinAPI.
|
||||
Вставьте в файл `.env` в формате:
|
||||
```
|
||||
COINAPI_KEY=тут для койнапи
|
||||
TELEGRAM_TOKEN=тут для телеграма
|
||||
```
|
||||
|
||||
В энв файл ещё можно такие переменные добавить:
|
||||
```
|
||||
DEBUG=false или true, включает отладочные логи
|
||||
TIMEOUT=таймаут для библиотеки requests, в секундах (2 по дефолту)
|
||||
```
|
||||
|
||||
## Хочу сделать пулл-реквест
|
||||
Ставьте pylint и mypy для статической проверки кода.
|
||||
Конфиги уже есть в репозитории.
|
||||
После проверок можете открывать PR.
|
||||
|
|
Loading…
Add table
Reference in a new issue