From eac73d9f67175f51541d58c8e71a5f3132e4f769 Mon Sep 17 00:00:00 2001
From: Ilya Kozhemyakin <kozhilya@gmail.com>
Date: Fri, 18 Apr 2025 22:57:49 +0400
Subject: [PATCH] =?UTF-8?q?=D0=9F=D1=80=D0=B0=D0=B2=D0=BA=D0=B0=20`README.?=
 =?UTF-8?q?md`,=20=D0=BF=D0=B5=D1=80=D0=B5=D0=BC=D0=B5=D1=89=D0=B5=D0=BD?=
 =?UTF-8?q?=D0=B8=D0=B5=20sql-=D1=81=D1=85=D0=B5=D0=BC=D1=8B=20=D0=B2=20?=
 =?UTF-8?q?=D0=B4=D1=80=D1=83=D0=B3=D1=83=D1=8E=20=D0=BF=D0=B0=D0=BF=D0=BA?=
 =?UTF-8?q?=D1=83?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md                               | 45 +++++++++++++++----------
 {Pf2eDataScrapper => dbml}/schema.pgsql |  0
 2 files changed, 27 insertions(+), 18 deletions(-)
 rename {Pf2eDataScrapper => dbml}/schema.pgsql (100%)

diff --git a/README.md b/README.md
index 5f42f33..fe34797 100644
--- a/README.md
+++ b/README.md
@@ -9,26 +9,17 @@
     - `DATA_DIR` - путь к папке для распаковки репозиториев обрабатываемых данных;
     - `OUTPUT_DIR` - путь к месту сохранения схем;
     - `DATABASE_CONNECTION` - строка подключения к БД (только PostreSQL).
-- Для создания структуры БД в командной строке запустите `dotnet ef database update`.
-- Проект готов к работе.
+- Перейдите а папку `Pf2eModel` (`cd ../Pf2eModel`) и запустите `dotnet ef database update` для создания структуры БД в командной строке.
 
+## Роли проектов
+
+- `Pf2eModel` - общая ORM-структура модели.
+- `Pf2eDataScrapper` - загрузчик и обработчик данных.
+- `Pf2eViewer` - программа отображения базы данных.
 
 ## Общая структура
 
-### `SchemaBuilder` 
-
-Классы обработки вводимых JSON-данных и создание схемы данных для использовании при формировании обработчиков данных.
-
-Использование:
-```csharp
-SchemaNode schema = new(); // Создание схемы данных
-
-data = JObject.Parse(reader.ReadToEnd()); // Загрузка данных
-
-schema.AddValue(data); // Добавление данных
-```
-
-### `Model`
+### `Pf2eModel`
 
 Набор классов модели ORM EntityFramework.
 
@@ -42,14 +33,32 @@ schema.AddValue(data); // Добавление данных
 - `Enum` содержит описание всех перечислений, использующихся в модели.
 - `Structure` содержит все основные типы, которые связаны 1-к-1 с `Entity` (для указания этого используется интерфейс `IEntity`).
 
-### `Migrations`
+#### `Migrations`
 
 Миграции БД, генерируются в автомотическом режиме.
 
-### `Importers`
+### `Pf2eDataScrapper`
+
+#### `SchemaBuilder` 
+
+Классы обработки вводимых JSON-данных и создание схемы данных для использовании при формировании обработчиков данных.
+
+Использование:
+```csharp
+SchemaNode schema = new(); // Создание схемы данных
+
+data = JObject.Parse(reader.ReadToEnd()); // Загрузка данных
+
+schema.AddValue(data); // Добавление данных
+```
+
+#### `Importers`
 
 Классы загрузки и обработки данных.
 
+### `Pf2eViewer`
+
+Программа для отображения данных. Не требует дополнительной настройки.
 
 # TODO
 
diff --git a/Pf2eDataScrapper/schema.pgsql b/dbml/schema.pgsql
similarity index 100%
rename from Pf2eDataScrapper/schema.pgsql
rename to dbml/schema.pgsql