From 72f1b9b41689432b7c96e5dab3f851db2a52fbb2 Mon Sep 17 00:00:00 2001
From: Anton Kovalev <antonko@gmail.com>
Date: Fri, 15 Mar 2024 22:01:03 +0300
Subject: [PATCH] docs: Update README.md

---
 README.md               | 48 ++++++++++++++++++++++++++---------------
 blurhasher/package.json |  2 +-
 docker-compose.yml      |  2 +-
 3 files changed, 33 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 5fdbbe4..99593cc 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,31 @@
 # Directus Blurhasher
 
-Это расширение для Directus, которое автоматически генерирует blurhash строки для изображений при их загрузке и сохраняет их в базе данных.
+Это расширение для Directus, которое автоматически генерирует blurhash строки для изображений при их загрузке.
 
-При использовании API Directus для работы с коллекцией directus_files, в дополнение к основным полям, будет добавлено поле `blurhash`, в котором будет храниться сгенерированная blurhash строка.
+Основные возможности:
+- Генерация и сохранение blurhash строк для изображений при их загрузке.
+- Возможность установки уровня детализации для генерации blurhash строк (Low, Medium, High).
+- Генерация blurhash строк для уже существующих изображений.
+- Автоматическая миграция при установке расширения.
 
-Это расширение было протестировано на версии v10.10.4 Directus, однако оно должно работать и на более ранних версиях.
+В системную коллекцию с иллюстрациями (`directus_files`), в дополнение к основным полям, добавляется поле `blurhash`, в котором будет храниться сгенерированная blurhash строка.
+
+## Настройки
+В разделе настроек Directus доступны следующие параметры:
+- **Gegenerate on restart** - при следующем запуске Directus будут сгенерированы blurhash строки для всех существующих изображений (выключится после генерации).
+- **Detail level** - уровень детализации для генерации blurhash строк (Low, Medium, High)
+
+Скорость генерации blurhash напрямую зависит от уровня детализации.
+
+Уровень детализации влияет на количество используемых компонентов при генерации blurhash строки. Чем выше уровень детализации, тем больше компонентов будет использовано, и тем более детализированной будет blurhash строка.
+
+- Low: 3x3 компонента
+- Medium: 6x6 компонента
+- High: 8x8 компонента
+
+## Требования
+
+Это расширение было протестировано на версии v10.0.0 Directus, однако оно должно работать и на более ранних версиях.
 
 ## Установка
 
@@ -26,25 +47,18 @@ RUN pnpm install directus-extension-blurhasher
 
 ## Разработка
 
-Для начала разработки вам необходимо запустить локальную копию Directus с помощью docker-compose.
-
-* Логин: `admin@example.com`
-* Пароль: `admin`
-
-```bash
-docker-compose up
-```
-
-После этого запустите процесс сборки в режиме разработки и следите за изменениями.
+Запустить процесс сборки в режиме разработки и docker образ Directus для тестирования.
 
 ```bash
 cd blurhasher
 npm install
 npm run dev
 ```
+Запуск самого Directus:
+```bash
+docker-compose up
+```
 
-Также рекомендуется использовать линтеры и форматирование кода.
+* Логин: `admin@example.com`
+* Пароль: `admin`
 
-```bash
-npm run lint
-```
\ No newline at end of file
diff --git a/blurhasher/package.json b/blurhasher/package.json
index d7fd563..5f0aebe 100644
--- a/blurhasher/package.json
+++ b/blurhasher/package.json
@@ -48,7 +48,7 @@
     "type": "hook",
     "path": "dist/index.js",
     "source": "src/index.ts",
-    "host": "^10.10.0"
+    "host": "^10.0.0"
   },
   "scripts": {
     "build": "directus-extension build",
diff --git a/docker-compose.yml b/docker-compose.yml
index 08d8f98..9723c7a 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,7 +1,7 @@
 version: "3"
 services:
   directus:
-    image: directus/directus:10
+    image: directus/directus:10.0.0
     ports:
       - 8055:8055
     volumes: