Merge pull request #4 from coder8080/better_readme

Improve README

Author: coder8080

README.md

@@ -1,28 +1,84 @@
-# USMILE Telegram Bot
+<a href="https://usmileclinic.ru/">
+    <img src="./media/site_logo.jpg" alt="Usmile logo" title="Usmile" align="right" height="60" />
+</a>
+
+# 🦷 USMILE Telegram Bot
+
+<p align="center">
+    <a href="https://t.me/usmile_cert_bot">
+        <img alt="telegram-bot" src="./media/bot_logo_small.png">
+    </a>
+</p>
 
 Телеграм бот для создания партнерских сертификатов стоматологии usmile
 
+⭐️ Поставьте звездочку - это очень мотивирует)
+
+## Функции
+
+- Администраторы могут создавать особые ссылки для партнеров
+- Пройдя по ссылке, партнер пополняет свой баланс
+- Партнер может создавать сертификаты, используя свой баланс
+- Администраторы могут проверить статус сертификата по его номеру
+- Администраторы могут пометить сертификат как использованный
+
 ## Техническая информация
 
 ### Стек
 
 - [Python3](https://www.python.org/)
-- [Aiogram3](https://aiogram.dev/)
-- [Peewee](https://github.com/coleifer/peewee)
-- [Docker](https://www.docker.com/)
-- [Docker Compose](https://docs.docker.com/compose/)
-- [PostgreSQL](https://www.postgresql.org/)
+- [Aiogram3](https://aiogram.dev/) - библиотека для создания телеграм-ботов
+- [Peewee](https://github.com/coleifer/peewee) - легковесная ORM
+- [Docker](https://www.docker.com/) - контейнеризация
+- [Docker Compose](https://docs.docker.com/compose/) - удобный запуск нескольких контейнеров
+- [PostgreSQL](https://www.postgresql.org/) - база данных
+- [Redis](https://redis.io/) - быстрое хранилище типа ключ-значение
+
+### Разработка
 
-### Запуск
+#### Установка зависимостей
 
-#### Продакшен
+Зависимости устанавливаются во время сборки Docker контейнера. Но чтобы в вашем редакторе кода работало автодополнение, рекомендуется также установить зависимости в виртуальную среду:
 
 ```bash
-docker compose --profile prod up --build -d
+python3 -m venv .venv
+source ./.venv/bin/activate
+pip install -r requirements.txt
 ```
 
-#### Разработка
+#### Запуск
 
 ```bash
 docker compose --profile dev up --build
 ```
+
+- `--profile dev` - использует параметры docker для разработки
+- `up` - запускает проект
+- `--build` - пересобирает контейнеры
+
+При внесении изменений в файлы на диске бот перепускается. Реализовано с помощью [volumes](https://docs.docker.com/engine/storage/volumes/) и [watchdog](https://pypi.org/project/watchdog/)
+
+#### Добавление новых пакетов
+
+Все пакеты, использующиеся проектом (даже во время разработки) должны быть добавлены в `requirements.txt`
+
+Команды ниже предполагают, чтовы уже [установили зависимости](#установка-зависимостей)
+
+```bash
+pip install package # package - ваш пакет
+pip freeze > requirements.txt # обновляет requirements.txt
+```
+
+### Продакшен
+
+_Сборка и деплой автоматизированы с помощью [github-actions](https://github.com/coder8080/usmile/actions)_
+
+**Команда запуска**
+
+```bash
+docker compose --profile prod up -d
+```
+
+- `--profile prod` - использует параметры docker для продакшена
+- `up` - запускает проект
+- `-d` - фоновый режим и запуск при загрузке системы