From 37d928921944a8cf9463dfc10550a8853c3e98bc Mon Sep 17 00:00:00 2001
From: Raykosan <71210053+Raykosan@users.noreply.github.com>
Date: Tue, 8 Apr 2025 02:50:09 +0300
Subject: [PATCH] Update README.md

---
 README.md | 93 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 92 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4e92e1a..fb98a30 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,92 @@
-# ComfyUI_RaykoStudio
\ No newline at end of file
+# ComfyUI_RaykoStudio  
+ComfyUI_RaykoStudio — это набор кастомных нод для ComfyUI, предоставляющий дополнительные возможности для работы с изображениями  
+В текущем релизе представлена нода `RS_RusTextOverlay`, которая позволяет накладывать текст на изображение в области, заданной маской, с поддержкой поворота текста, кастомных шрифтов, переноса строк и прозрачности.    
+
+## Нода: 🦊 RS_RusTextOverlay  
+
+### Описание  
+
+`RS_RusTextOverlay` позволяет накладывать текст на изображение в области, заданной маской. Нода поддерживает поворот текста в соответствии с углом наклона маски, автоматический подбор размера шрифта, кастомные шрифты, перенос строк, табуляцию и настройку прозрачности текста.  
+
+#### Возможности  
+
+- Наложение текста на изображение в области, заданной маской.  
+- Автоматический поворот текста в соответствии с углом наклона маски (опционально).  
+- Поддержка кастомных шрифтов (`.ttf` или `.otf`), загружаемых из папки `fonts`.  
+- Автоматический подбор размера шрифта для вписывания текста в область маски.  
+- Настройка цвета текста и прозрачности (от 0 до 100%).  
+- Настройка выравнивания текста (вертикальное: top/center/bottom, горизонтальное: left/center/right).  
+- Настройка отступов (padding) вокруг текста.  
+
+#### Входы  
+
+- `image`: Изображение (тензор формата RGB).  
+- `mask`: Маска (тензор формата L), определяющая область для текста.  
+
+#### Выходы  
+
+- `IMAGE`: Изображение с наложенным текстом (тензор формата RGB).  
+
+#### Параметры  
+
+- `text`: Текст для наложения. Поддерживает перенос строк.  
+- `font_name`: Выберите шрифт из списка доступных в папке `fonts` (или используйте `default`).  
+- `text_color`: Цвет текста (в формате HEX, например `#FFFFFF`).  
+- `text_opacity`: Прозрачность текста (0–100%, где 0 — полностью прозрачный, 100 — полностью непрозрачный).  
+- `min_font_size`: Минимальный размер шрифта (если текст не помещается, используется шрифт по умолчанию).  
+- `padding`: Отступы вокруг текста внутри маски.  
+- `vertical_align`: Вертикальное выравнивание текста (top/center/bottom).  
+- `horizontal_align`: Горизонтальное выравнивание текста (left/center/right). 
+- `rotate_with_mask`: Включить/выключить поворот текста в соответствии с углом наклона маски.  
+
+## Установка  
+
+1. Клонируйте репозиторий или скопируйте папку `ComfyUI_RaykoStudio` в папку `custom_nodes` вашего ComfyUI:  
+
+ComfyUI/custom_nodes/ComfyUI_RaykoStudio/  
+
+2. Убедитесь, что папка `fonts` содержит шрифты (`.ttf` или `.otf`). Вы можете добавить свои шрифты в эту папку. Если папка пуста или отсутствует, будет использоваться шрифт по умолчанию.  
+
+3. Установите необходимые зависимости, указанные в `requirements.txt`: pip install -r requirements.txt  
+
+  Перезапустите ComfyUI, чтобы нода стала доступна.  
+
+## Зависимости  
+
+Для работы ноды требуются следующие библиотеки (указаны в requirements.txt):  
+
+    torch>=1.7.0  
+    numpy>=1.19.0  
+    Pillow>=8.0.0  
+    opencv-python>=4.5.0  
+
+## Использование  
+
+После установки найдите ноду в ComfyUI под названием 🦊 RS_RusTextOverlay (категория: 🦊 RaykoStudio/Image).  
+Подключите входные данные (image и mask) и настройте параметры.  
+Пример рабочего процесса можно найти в папке examples:  
+    example workflow.json: Пример рабочего процесса для ComfyUI.  
+    example.png: Скриншот результата.  
+
+
+## Сообщение об ошибках (Issues)  
+
+Если вы столкнулись с проблемой или нашли баг:  
+
+Проверьте раздел Issues на GitHub, возможно, проблема уже известна.
+Если проблема новая, создайте новый Issue, описав:
+        Версию ComfyUI и Python.
+        Описание проблемы и шаги для ее воспроизведения.
+        Скриншоты или логи ошибок (если есть).
+
+## Лицензия
+
+MIT License. Используйте ноду на свое усмотрение, но без каких-либо гарантий.
+
+## Автор
+
+Создано 🦊 RaykoStudio.  
+
+## Благодарности
+
+Спасибо сообществу ComfyUI за вдохновение и поддержку! Если вам понравилась эта нода, не забудьте поставить звездочку на GitHub!