Update README.md

Signed-off-by: Billionaire DendiBoss <[email protected]>

README.md

@@ -1,3 +1,34 @@
-# API & Documentation — For DEX on TON
+# Comprehensive Backend Services for Decentralized Exchanges on TON Blockchain
 
-API DEX on TON for Developer — Backend Services
+Проект API-DEX-TON-Blockchain на GitHub представляет собой комплексную бэкенд-платформу для децентрализованных бирж (DEX) на блокчейне TON. Основная цель проекта - предоставление мощного API для разработки и интеграции децентрализованных финансовых услуг.
+
+## Составные части проекта
+
+- **.github:** Настройки GitHub Actions для автоматизации процессов разработки, включая недавнее обновление actions/checkout с версии 3 на 4.
+- **Core:** Ключевой модуль проекта, в котором реализована основная бизнес-логика и удалены резервы v1 для повышения производительности и безопасности.
+- **Observer:** Модуль наблюдения за блокчейном, обеспечивающий мониторинг транзакций.
+- **REST-v2 и REST:** RESTful API интерфейсы, обновлены с использованием org.springdoc:springdoc-openapi-kotlin для улучшенной интеграции и документации API.
+- **Ton-Indexer:** Модуль для индексации данных блокчейна TON, обновлен до ton-kotlin 0.2.14 для оптимизации процессов.
+
+## Важные обновления
+
+- **Удаление резервов v1:** Основной фокус на улучшении эффективности и безопасности системы.
+- **Инициализация gradle/wrapper и gradlew:** Начальная настройка Gradle для управления зависимостями и сборкой проекта.
+- **Renovate.json:** Внедрение Renovate для автоматического управления зависимостями проекта.
+- **Build.gradle.kts и settings.gradle.kts:** Интеграция современных практик и инструментов разработки для повышения эффективности процессов.
+
+## Начало работы
+
+Для начала работы с проектом:
+
+1. Клонируйте репозиторий.
+2. Изучите документацию и ознакомьтесь с различными модулями и компонентами.
+3. Настройте свою среду разработки согласно инструкциям в gradlew и gradle/wrapper.
+
+## Вклад в проект
+
+Мы открыты для вклада сообщества. Это может быть исправление ошибок, улучшение документации или добавление новых функций. Прежде чем приступить к работе, ознакомьтесь с руководством по вкладу в проект.
+
+## Лицензия и использование
+
+Код проекта распространяется под лицензией MIT, что обеспечивает гибкость и широкие возможности для использования и модификации.