From 50ffdbc24a076e5f689ea3864bd99f921458a84e Mon Sep 17 00:00:00 2001
From: DarkCat09 <a.chechkenev@yandex.ru>
Date: Tue, 30 May 2023 14:59:36 +0400
Subject: [PATCH] Updated readme, license notice

---
 LICENSE   |  2 +-
 README.md | 22 ++++++++++++++++++++++
 2 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/LICENSE b/LICENSE
index dbc1b68..ecd20b0 100644
--- a/LICENSE
+++ b/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
diff --git a/README.md b/README.md
index ae7d313..519550e 100644
--- a/README.md
+++ b/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.