docx: added about project in the README.md

README.md

@@ -1,2 +1,52 @@
 # kawai-focus-v2
 Kawai-Focus - приложение для фокусировки внимания на основе таймера Pomodoro.
+
+роект находится на стадии разработки MVP1:
+
+- **Pomodoro** - таймеры для техники Pomodoro, которая управляет вашим временем работы и перерывами на отдых;
+- **Гайд** - информация о том как использовать таймеры и приложение, а так же о самой технике Pomodoro;
+- **Ограничение приложений** - управление ограничением работы отвлекающих от работы приложений.
+
+## Стек
+
+- **Python** - язык программирования;
+- **Uv** - инструмент для управления зависимостями и виртуальными окружениями;
+- **FastAPI** — вся логика приложения и бекенд;
+- **Vue.js** — отвечает за внешний вид (фронтенд);
+- **Ionic** — нативный UI и мобильная версия;
+- **Tauri** — движок для десктопной версии приложения.
+
+## Автор
+
+**Разработчик проекта:**
+
+- **Имя и Фамилия** - Евгений Каддо
+- **Никнейм** - Arduinum628
+
+Подробно рассказываю о процессе написания кода приложения в своих статьях <a href="https://pressanybutton.ru/category/kawai-focus/">kawai-focus</a> на сайте <a href="https://pressanybutton.ru">Код на салфетке</a>.
+
+<details>
+  <summary>
+    <strong>
+      Как оформлять ветки и коммиты
+    </strong>
+  </summary>
+
+Пример ветки `nickname/name_task`
+
+- **nickname** (никнейм в github);
+- **name_task** (название задачи - название карточки на yougile).
+
+Пример коммита `refactor: renaming a variable`
+
+- **feat:** (новая функционал кода, БЕЗ учёта функционала для сборок);
+- **devops:** (функционал для сборки, - добавление, удаление и исправление);
+- **fix:** (исправление ошибок функционального кода);
+- **docs:** (изменения в документации);
+- **style:** (форматирование, отсутствующие точки с запятой и т.п., без изменения производственного кода);
+- **refactor:** (рефакторинг производственного кода, например, переименование переменной);
+- **test:** (добавление недостающих тестов, рефакторинг тестов; без изменения производственного кода);
+- **chore:** (обновление рутинных задач и т. д.; без изменения производственного кода).
+
+Оформление основано на https://www.conventionalcommits.org/en/v1.0.0/
+</details>