From 2a063481a6948aab53146a1f80ef37ec38bf26c1 Mon Sep 17 00:00:00 2001
From: Julian Lechner <fraujulian@lechner.top>
Date: Fri, 2 Oct 2026 13:35:38 +0200
Subject: [PATCH] docs: reorganize project README

---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 58 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 0a22baf..6f16475 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,64 @@
-# HTML Simple Maintenance Page
+# Maintenance Website
 
-### [🙋‍♂️ Website Preview](https://lechner-systems.at/)
+A lightweight maintenance page served as a static website.
 
-### 🪪 License
-Icons: [Icons8.com](https://icons8.com/)
+## Preview
 
-Modified by Julian Lechner.  
-Based on Simple Maintenance Page by theoricher.  
-Licensed under GNU GPL v3.  
+[Open the live preview](https://lechner-systems.at/)
 
-## 🤝 Enjoy?
+## Technology
 
-Give it a star ⭐ on [Gitea](https://git.lechner-systems.at/FrauJulian/Personal-Portfolio-Website)!
+- HTML, CSS, and vanilla JavaScript
+- Nginx
+- Docker and Docker Compose
 
-### Greetings from Austria! ⛰️
+## Features
+
+- Selects a maintenance message from the browser's preferred language, with English fallback
+- Supports English, German, Slovak, Czech, Dutch, Swedish, Norwegian, Polish, Italian, French, Spanish, Slovenian, and Danish
+- Provides email, abuse, phone, imprint, and status links
+
+## Project Architecture
+
+- `index.html` — page content and contact links
+- `style.css` — page layout and styling
+- `script.js` — language selection
+- `images/` — page images and icons
+- `nginx.conf` — web server configuration
+- `Dockerfile` — production image definition
+- `docker-compose.yml` — production service configuration
+
+## Setup
+
+### Development
+
+From the project root, start a local static server:
+
+```sh
+python -m http.server 8000
+```
+
+Open <http://localhost:8000>.
+
+### Production
+
+Requires Docker Compose and access to the configured image registry. Copy the example environment file, set `IMAGE_TAG` if needed, then start the service:
+
+```sh
+cp .env.example .env
+docker compose up -d
+```
+
+The page is available at <http://localhost:8080> by default. Set `MAIN_PORT` in `.env` to change the host port.
+
+## Tests
+
+There is no dedicated test suite. CI checks JavaScript syntax with `node --check` and builds the Docker image.
+
+## Guidelines
+
+Use the issue templates in [`.gitea/ISSUE_TEMPLATE`](.gitea/ISSUE_TEMPLATE) for bug reports and feature requests.
+
+## LICENSE
+
+The project is licensed under the [GNU General Public License v3](LICENSE). Icons by [Icons8](https://icons8.com/).