20250808

README.md

@@ -1,5 +1,94 @@
-# php_db_components_pack
+# 📌🇷🇺 Русская версия
 
-[RU] Набор компонентов для сайта на PHP для работы с базами данных
+---
 
-[EN] A set of components for PHP website for work with database
+## Пакет компонентов для работы с базами данных на PHP
+
+**PhpDbComponentsPack** — это пакет инструментов для эффективного взаимодействия с базами данных на языке
+программирования PHP. Данный пакет предоставляет разнообразные классы и компоненты, предназначенные для облегчения
+работы с базами данных, начиная от низкоуровневых операций и заканчивая высокоуровневыми конструкциями, такими как
+моделирование и обработка данных.
+
+### ✅ Функционал:
+
+- Базовые компоненты для взаимодействия с различными СУБД (MySQL, PostgreSQL, SQLite и др.).
+- Универсальные классы для построения SQL-запросов и выполнения операций с данными.
+- Гибкая настройка полей и моделей данных для использования в базе данных.
+- Поддержка авто-масштабируемых полей и автоинкрементных значений.
+- Средства для анализа и контроля данных.
+
+### ⚙️ Установка и использование:
+
+Установка осуществляется через Composer:
+
+```bash
+composer require goodboyalex/php_db_components_pack
+```
+
+Затем импортируйте нужные классы и начинайте использовать их:
+
+```php
+use goodboyalex\php_db_components_pack\classes\Database;
+use goodboyalex\php_db_components_pack\models\DataBaseColumn;
+
+// Пример использования
+$database = new Database(...);
+```
+
+### 🛠️ Поддерживаемые технологии:
+
+- PHP 8.4+
+- MySQL, PostgreSQL, SQLite, MS SQL
+- Компоненты основаны на PDO и популярных паттернах ORM
+
+### 💬 Вопросы и помощь:
+
+Подробную справку и руководство по работе с пакетом смотрите в [справочном руководстве](./help/index.md).
+
+---
+
+# 📌🇬🇧 English Version
+
+---
+
+## PHP Components Pack for Working with Databases
+
+**PhpDbComponentsPack** is a toolkit designed to simplify working with databases in the PHP programming language. This
+package provides various classes and components aimed at making database operations more efficient, ranging from
+low-level operations to high-level constructs such as data modeling and processing.
+
+### ✅ Features:
+
+- Basic components for interacting with different DBMS (MySQL, PostgreSQL, SQLite, etc.).
+- Universal classes for building SQL queries and performing data operations.
+- Flexible configuration of fields and data models for usage in databases.
+- Support for auto-scalable fields and autoincrement values.
+- Tools for analyzing and controlling data.
+
+### ⚙️ Installation & Usage:
+
+Installation via Composer:
+
+```bash
+composer require goodboyalex/php_db_components_pack
+```
+
+Then import necessary classes and start using them:
+
+```php
+use goodboyalex\php_db_components_pack\classes\Database;
+use goodboyalex\php_db_components_pack\models\DataBaseColumn;
+
+// Example usage
+$database = new Database(...);
+```
+
+### 🛠️ Supported Technologies:
+
+- PHP 8.4+
+- MySQL, PostgreSQL, SQLite, MS SQL
+- Components based on PDO and popular ORM patterns
+
+### 💬 Questions & Help:
+
+For detailed reference and user guide, please refer to the [reference manual](./help/index.md) (russian version only).