From c063160a48e68ccb1f4a0b31ffceba0b69f0e9fd Mon Sep 17 00:00:00 2001
From: escfrpls <licwin1410@gmail.com>
Date: Fri, 24 Jul 2026 19:20:42 +0200
Subject: add READMY

---
 README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 71 insertions(+), 10 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 11bbe12..3f6a731 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,79 @@
-# Documentation
+# 🏛️ AI Genealogy / ИИ Генеалогия
 
-### Russia
-**Здесь хранятся мои личные заметки, инструкции, гайды и другие вспомогательные материалы - просто чтобы не забыть и всегда иметь под рукой.**
+**Local AI assistant for genealogical research**  
+**Локальный ИИ-помощник для генеалогических исследований**
 
-Репозиторий не привязан к отдельному сайту, это коллекция полезных записей.
+---
 
-*   📂 Репозиторий: [https://git.drohiczyn-poleski.com/documentation.git](https://git.drohiczyn-poleski.com/documentation.git)
+## 🇬🇧 What is this?
 
----
+A fully local, open-source AI toolkit for genealogical research. It runs entirely on your computer — no cloud services, no subscriptions, no data leaks.
+
+### Capabilities
+- 🔍 **Semantic search** through your archive of digitized documents
+- 📜 **OCR recognition** of old metric books, scans, and manuscripts (Russian, Polish, Belarusian)
+- 🌐 **Private web search** via SearXNG meta-search engine
+- 🕸️ **Website scraping** of genealogy forums and archives
+- 💬 **AI chat** with context from your documents (RAG)
+- 🧠 **Analysis** of surnames, dates, places, family connections
+
+### Tech Stack
+| Component | Purpose |
+|-----------|---------|
+| Open WebUI | Web interface |
+| Ollama + Qwen2.5/Mistral | LLM |
+| Qdrant + BGE-M3 | Vector search |
+| EasyOCR + Tesseract | OCR |
+| SearXNG | Web search |
+| Crawl4AI | Web scraping |
+| FastAPI | Integration API |
+
+### Quick Start
+```bash
+ai-genealogy start    # Launch
+ai-genealogy stop     # Shutdown (GPU freed)
+
+Web UI: http://localhost:3000
+API Docs: http://localhost:8000/docs
+
+----------------------------------------------------------------------------------------------
+
+Полностью локальный, открытый AI-инструментарий для генеалогических исследований. Всё работает на вашем компьютере — без облаков, подписок и утечек данных.
+Возможности
+
+    🔍 Семантический поиск по вашему архиву оцифрованных документов
+
+    📜 Распознавание (OCR) старых метрических книг, сканов, рукописей (русский, польский, белорусский)
+
+    🌐 Приватный веб-поиск через мета-поисковик SearXNG
+
+    🕸️ Скрапинг сайтов — генеалогических форумов и архивов
+
+    💬 AI-чат с контекстом из ваших документов (RAG)
+
+    🧠 Анализ фамилий, дат, мест, родственных связей
+
+Технологический стек
+Компонент	Назначение
+Open WebUI	Веб-интерфейс
+Ollama + Qwen2.5/Mistral	Языковая модель (LLM)
+Qdrant + BGE-M3	Векторный поиск
+EasyOCR + Tesseract	Распознавание текста
+SearXNG	Веб-поиск
+Crawl4AI	Скрапинг сайтов
+FastAPI	API-интеграция
+Быстрый старт
+bash
+
+ai-genealogy start    # Запуск
+ai-genealogy stop     # Выключение (GPU освобождается)
 
-### English
+Веб-интерфейс: http://localhost:3000
+API документация: http://localhost:8000/docs
 
-**This is where I keep my personal notes, how‑to guides, instructions and other reference materials - so I don’t forget them and always have them at hand.**
+----------------------------------------------------------------------------------------------
 
-The repository is not linked to a dedicated website; it is just a collection of useful writings.
+🔓 License / Лицензия
 
-*   📂 Repository: [https://git.drohiczyn-poleski.com/documentation.git](https://git.drohiczyn-poleski.com/documentation.git)
+All components are open-source (MIT, Apache 2.0, AGPLv3).
+Все компоненты с открытым исходным кодом (MIT, Apache 2.0, AGPLv3).
-- 
cgit v1.2.3