first commit

docs/ru/overview.md

@@ -0,0 +1,34 @@
+# Overview (RU)
+
+Database - SQL plugin for Lumi with MySQL/PostgreSQL, HikariCP pooling,
+schema helpers, raw SQL, and a lightweight ORM with fluent query builder.
+
+## Установка
+
+1. Соберите jar через Gradle.
+2. Поместите jar в папку plugins сервера.
+3. Запустите сервер один раз для генерации `config.yml`.
+
+## Доступ к API
+
+```java
+import com.andrewkydev.database.DatabaseProvider;
+import com.andrewkydev.database.DatabaseApi;
+
+DatabaseApi api = DatabaseProvider.get();
+```
+
+## Основные возможности
+
+### Auto ID после insert
+
+Если у поля есть `@DbId(autoIncrement = true)` и id пустой (0 или null),
+`insert()` получает generated keys и прописывает id в объект.
+
+### Snake case по умолчанию
+
+Если не задано `@DbEntity`/`@DbColumn`, имена берутся в snake_case.
+
+### Удобные ORM методы
+
+Доступны `findOneWhere`, `deleteWhere` и `findWhere` с сортировкой/лимитом/offset.