From a81a2c1b6871870635cc14cbe11839a9c29df13a Mon Sep 17 00:00:00 2001
From: Dmitry Dementev <me@dementev.space>
Date: Thu, 5 Feb 2026 22:11:10 +0300
Subject: [PATCH] docs: add project readme

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e99a3a0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Kaniskin docker ETL (mini clickstream demo)
+
+Мини‑демо аналитического стека: Kafka → ClickHouse (STG → ODS → DDS → DM) + Superset + мониторинг.
+
+## Документация
+
+- Схема слоёв и DDL (в т.ч. Kafka → STG): `plans/clickhouse_ddl.md`
+- Runbook (как поднимать/применять DDL/лить данные): `plans/runbook.md`
+
+## Что где лежит
+
+- Исходные данные: `data/*_events.jsonl`
+- Скрипты:
+  - применение DDL: `scripts/apply_clickhouse_ddl.sh`
+  - загрузка данных в Kafka: `scripts/load_kafka_data.sh`
+
+## Порты сервисов
+
+См. `docker-compose.yml`:
+
+- ClickHouse native: `localhost:8002`
+- ClickHouse HTTP: `localhost:9123`
+- Kafka: `localhost:9092`
+- Kafka UI: `http://localhost:8082`
+- Prometheus: `http://localhost:9090`
+- Grafana: `http://localhost:3000`
+- Superset: `http://localhost:8088`