Update README and Docker Compose configuration for clarity and improved setup instructions

Author: NLion74

README.md

@@ -1,20 +1,77 @@
-# WebUntis Timetable ICS Exporter
+# ICS-WebUntis
 
-A Node.js/TypeScript service that generates ICS calendar files from WebUntis timetables.
+ICS-WebUntis is a lightweight service that exports timetables from [WebUntis](https://www.untis.at/) as `.ics` calendar feeds.  
+It is designed for reliability, minimal resource usage, and straightforward deployment via Docker.
 
 ## Features
 
--   Generates `.ics` calendar files for multiple users.
--   Supports caching for improved performance.
--   Configurable via `config.json` or environment variables.
--   Works in development (`ts-node`) and production (Docker).
+-   Fetch timetables directly from WebUntis
+-   Expose an `.ics` calendar endpoint for integration with any calendar client
+-   Built-in caching to reduce load on WebUntis
+-   Single-container deployment with Docker
+-   Strictly validated configuration
+-   Multiple Users supported
 
-## Getting Started
+## Quick Start
 
-### Development
+### Run with Docker Compose
 
 ```bash
-git clone https://github.com/NLion74/ics-webuntis.git
-cd ics-webuntis
-docker-compose -f dev-docker-compose.yml up
+version: "3.3"
+
+services:
+    webuntis-timetable:
+        image: nlion/ics-webuntis:latest
+        container_name: webuntis-timetable
+        environment:
+            - NODE_ENV=production
+            - PORT=7464
+            - CONFIG_FILE=/app/config.json
+        volumes:
+            - ./dev-config.json:/app/config.json:ro
+        ports:
+            - "7464:7464"
+        restart: unless-stopped
+
+```
+
+Start it with 'docker-compose up'
+
+This will fail without a 'config.json'
+
+## Configuration
+
+The service requires a JSON configuration file.
+`config.json` example
+
+```
+{
+    "daysBefore": 7,
+    "daysAfter": 14,
+    "cacheDuration": 300,
+    "users": [
+        {
+        "school": "myschool",
+        "username": "student1",
+        "password": "secret",
+        "baseurl": "https://mese.webuntis.com/WebUntis/",
+        "friendlyName": "student1"
+        }
+    ]
+}
 ```
+
+## Usage
+
+Once running, the service exposes an `.ics` feed:
+
+```
+http://<host>:7464/timetable/friendlyName.ics
+
+```
+
+friendlyName represents the one specified in the user configuration. This link can be subscribed to any calendar client and just works out of the box.
+
+## Contributing
+
+Feel free to contribute at any time! If so either create an issue to discuss your changes first or just open a Pull Request if you prefer.

docker-compose.yml

@@ -1,3 +1,5 @@
+version: "3.3"
+
 services:
     webuntis-timetable:
         image: nlion/ics-webuntis:latest