From 8b89e4a9933475ce9a91430e33d84e44caeabc6a Mon Sep 17 00:00:00 2001
From: Arduinum628 <message.chaos628@gmail.com>
Date: Wed, 21 May 2025 17:48:54 +0300
Subject: [PATCH] docs: added project description and design of branches and
 commits

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 27fb282..d0d0eed 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,29 @@
-# robot-pi-service
\ No newline at end of file
+# Robot-pi-service
+
+**Robot-pi-service** - сервис для управления роботом на orange pi, работающий на linux Armbian.
+
+<details>
+	<summary>
+		<strong>
+			Как оформлять ветки и коммиты
+		</strong>
+	</summary>
+	
+	Пример ветки `user_name/name_task`
+	
+    - **user_name** (имя пользователя);
+    - **name_task** (название задачи).
+	
+	Пример коммита `refactor: renaming a variable`
+	
+	- **feat:** (новая функционал кода, БЕЗ учёта функционала для сборок);
+	- **devops:** (функционал для сборки, - добавление, удаление и исправление);
+	- **fix:** (исправление ошибок функционального кода);
+	- **docs:** (изменения в документации);
+	- **style:** (форматирование, отсутствующие точки с запятой и т.п., без изменения производственного кода);
+	- **refactor:** (рефакторинг производственного кода, например, переименование переменной);
+	- **test:** (добавление недостающих тестов, рефакторинг тестов; без изменения производственного кода);
+	- **chore:** (обновление рутинных задач и т. д.; без изменения производственного кода).
+	
+	Оформление основано на https://www.conventionalcommits.org/en/v1.0.0/
+</details>
\ No newline at end of file