update readme with head

Author: CodeShellDev

.github/templates/README.template.md

@@ -1,56 +1,116 @@
 # WoL Dockerized
 
-WoL Dockerized is a Docker Container that allows you to start requested Docker Containers.
-It also stops Containers after a threshold of Inactivity.
+<p align="center">
+🖥️ On-Demand Docker Orchestration · Auto-Stop Inactive Containers · HTTP & WebSocket Interface
+</p>
+
+<div align="center">
+  <a href="https://github.com/codeshelldev/wol-dockerized/releases">
+    <img 
+        src="https://img.shields.io/github/v/release/codeshelldev/wol-dockerized?sort=semver&logo=github&label=Release" 
+        alt="GitHub release"
+    >
+  </a>
+  <a href="https://github.com/codeshelldev/wol-dockerized/stargazers">
+    <img 
+        src="https://img.shields.io/github/stars/codeshelldev/wol-dockerized?style=flat&logo=github&label=Stars" 
+        alt="GitHub stars"
+    >
+  </a>
+  <a href="https://github.com/codeshelldev/wol-dockerized/pkgs/container/wol-dockerized">
+    <img 
+        src="https://ghcr-badge.egpl.dev/codeshelldev/wol-dockerized/size?color=%2344cc11&tag=latest&label=Image+Size&trim="
+        alt="Docker image size"
+    >
+  </a>
+  <a href="https://github.com/codeshelldev/wol-dockerized/pkgs/container/wol-dockerized">
+    <img 
+        src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fghcr-badge.elias.eu.org%2Fapi%2Fcodeshelldev%2Fwol-dockerized%2Fwol-dockerized&query=downloadCount&label=Downloads&color=2344cc11"
+        alt="Docker image Pulls"
+    >
+  </a>
+  <a href="./LICENSE">
+    <img 
+        src="https://img.shields.io/badge/License-MIT-green.svg"
+        alt="License: MIT"
+    >
+  </a>
+</div>
+
+---
+
+## Features
+
+- Start Docker containers via simple HTTP requests.
+- Automatically stop inactive containers.
+- Integrates with [WoL-Redirect](https://github.com/codeshelldev/wol-redirect) for a graphical interface.
+- Provides real-time process updates via WebSocket.
 
 ## Installation
 
-Get the latest `docker-compose.yaml` file:
+1. Get the latest `docker-compose.yaml` file:
 
-```yaml
+```
 {{{ #://docker-compose.yaml }}}
 ```
 
-```bash
+2. Start the container:
+
+```
 docker compose up -d
 ```
 
-Combine with [WoL-Redirect](https://github.com/codeshelldev/wol-redirect) for a graphical interface.
+3. Optionally, combine with [WoL-Redirect](https://github.com/codeshelldev/wol-redirect) for a web interface.
 
 ## Setup
 
-### Auto-stop
+### Auto Stop
+
+To enable automatic stopping of containers after a period of inactivity, you must redirect requests to:
 
-If you want your Docker Containers to automatically stop after a certain Inactivity Threshold you will have to somehow redirect requests to said service
-through `http://localhost:7777/endpoint`.
+'''
+http://wol-dockerized:7777/activity
+'''
 
 > [!NOTE]
-> This is currently not that simple
-> you cannot just redirect to `/endpoint`,
-> you will have to use a _forward auth_ middleware
-> this means `wol-dockerized` currently just responds with 200 OK
+> This is currently not straightforward. You cannot just redirect to `/activity`. You need to use a _forward auth_ middleware.  
+> Currently, `wol-dockerized` will respond with `200 OK`.
 
-#### Traefik
+### Traefik Integration
 
-Look at [forward auth](https://doc.traefik.io/traefik/middlewares/http/forwardauth/)
+See [Traefik Forward Auth Middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) for details on how to integrate.
 
 ## Usage
 
-Start Container with `query`: `jellyfin.mydomain.com`:
+Start a container by specifying a `query`, for example: `jellyfin.mydomain.com`:
 
-```bash
-curl -X POST -H "Content-Type: application/json" -d '{"query": "jellyfin.mydomain.com"}' http://localhost:7777
 ```
+curl -X POST -H "Content-Type: application/json" -d '{"query": "jellyfin.mydomain.com"}' http://wol-dockerized:7777/wake
+```
+
+Example `docker-compose` configuration for the container:
 
-```yaml
+```
 {{{ #://examples/jellyfin.docker-compose.yaml }}}
 ```
 
+**WoL Dockerized** will respond with a `client_id`, which can be used to establish a **WebSocket connection** at:
+
+```
+ws://wol-dockerized:7777/ws
+```
+
+The WebSocket sends updates for each step of the process. The response contains:
+
+- `success`: `true` if the process finished successfully.
+- `error`: `true` if the process failed.
+- `message`: descriptive information about what happened.
+
 ## Contributing
 
-Found a bug or have new ideas or enhancements for this Project?
-Feel free to open up an issue or create a Pull Request!
+Found a bug or have ideas for new features?  
+Feel free to open an issue or submit a Pull Request!
 
 ## License
 
-This project is licensed under the [MIT License](./LICENSE).
+This project is licensed under the [MIT License](./LICENSE)