From ea463f35f4a7a822687695a18f772449d26e6dd7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=90=D0=BD=D1=82=D0=BE=D0=BD=20=D0=A2=D1=80=D0=BE=D1=88?=
 =?UTF-8?q?=D0=B8=D0=BD?= <i@atroshin.ru>
Date: Thu, 23 Jul 2026 02:53:28 +0300
Subject: [PATCH] readme added

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d08f6b2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# Ponomar — Orthodox Calendar PWA
+
+A Progressive Web App for Orthodox Church calendar, liturgical services, and Bible readings.
+
+Derived from the original [Java Ponomar application](https://github.com/typiconman/ponomar) by [Sergei F.](https://github.com/typiconman).
+
+## Features
+
+- **Calendar** — View month grids with liturgical days, fasting periods, ranks, and commemorations. Supports Julian calendar with Gregorian equivalents.
+- **Service Reader** — Assembles liturgical services (Hours, Vespers, Matins, Liturgy) from structured XML templates with conditional logic.
+- **Bible Reader** — Read scripture across 13 versions (Church Slavonic, Russian Synodal, KJV, Brenton, Vulgate, etc.). Per-version reading position persists across sessions.
+- **Multi-language UI** — English, Russian, Church Slavonic (with dedicated Slavonic fonts).
+- **PWA** — Installable on desktop and mobile devices.
+
+## Tech Stack
+
+- [TypeScript](https://www.typescriptlang.org/) — fully typed
+- [Vite](https://vitejs.dev/) — build tool
+- [Tailwind CSS v4](https://tailwindcss.com/) — utility-first CSS
+- [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) — service XML conversion
+
+## Getting Started
+
+```bash
+npm install
+npm run dev
+```
+
+The data conversion from the Java project's XML sources happens automatically as part of the build. Point the conversion script at your local clone of the Java Ponomar repository by setting `PONOMAR_JAVA_HOME` (defaults to `../ponomar`).
+
+```bash
+npm run build    # production build
+npm run preview  # preview production build
+```
+
+## Project Structure
+
+```
+src/
+  core/          — Domain logic (calendar, paschalion, service assembly, i18n)
+  ui/            — View components (app, calendar, bible, service, settings)
+  main.ts        — Entry point
+scripts/         — XML-to-JSON conversion tools
+static/
+  data/          — Generated liturgical data (not committed, built from Java XML)
+  fonts/         — Church Slavonic fonts
+  icons/         — PWA icons
+```
+
+## License
+
+Same as the original Java project.