docs: overwrite README with project description and centered preview image

README.md

@@ -1,31 +1,19 @@
-# Vue 3 + Vite
+# Rubik's Cube Logic Engine & Simulator
 
-This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+![Cube Preview](./public/preview.png)
 
-Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support).
+## Overview
 
-## Uruchamianie (Automatyczne - CI/CD)
+This application is a 3D animated, Interactive Rubik's Cube simulator and mathematical solver built from scratch using Vue.js. It aims to provide seamless mechanical interactions and mathematically perfectly rigorous tracking of a classic 3x3 Rubik's Cube state. 
 
-Projekt wykorzystuje **Gitea Actions** z runnerem **self-hosted** na serwerze produkcyjnym.
+The software operates entirely in the browser using a custom Group Theory mathematical engine (`DeepCube.js`), which separates the heavy analytical permutation tracking from the 3D CSS visual layer using Web Workers.
-Każdy push do gałęzi `main` automatycznie:
-1. Pobiera kod na serwerze.
-2. Zatrzymuje i usuwa stare kontenery.
-3. Buduje i uruchamia nową wersję aplikacji przy użyciu `docker compose up -d --build`.
 
-### Konfiguracja Sieci i Bezpieczeństwa (Izolacja)
+## Features
 
-Aplikacja wykorzystuje dwie sieci dockerowe dla zapewnienia izolacji:
+- **Mechanical Realism:** 3D CSS rendering precisely models physical cube mechanics. Dragging edge and corner pieces rotates the specific mechanical layer dynamically, while dragging the center elements pivots the entire camera view.
-1.  `npm_public` (zewnętrzna): Sieć, w której znajduje się Nginx Proxy Manager. Tylko kontener `rubic-cube` jest do niej podłączony, aby NPM mógł przekierować ruch.
+- **Reactive Algorithm Queue:** Execute complex algorithms fluidly. The dynamic queue evaluates incoming inputs and instantly intercepts redundances (e.g. evaluating `U U` into a single `U2` animation, or cancelling out `F` into `F'` on the fly).
-2.  `rubic-net` (wewnętrzna): Prywatna sieć aplikacji. Wszelkie inne serwisy (np. baza danych, redis - jeśli dodasz w przyszłości) powinny być tylko w tej sieci, niewidoczne dla NPM ani innych aplikacji.
+- **Deep Mathematical Engine:** Based entirely on Group Theory. It stores corner and edge permutation arrays combined with spatial orientation parities to guarantee that only physically legal mechanical states exist or can be scrambled.
-
+- **Intelligent Solvers:** 
-**Wymagania:**
+    - **Beginner Method (Human):** Constructs the solution layer-by-layer simulating human heuristics natively with instantaneous $O(1)$ algorithmic macros.
-Przed uruchomieniem upewnij się, że na serwerze istnieje sieć publiczna dla proxy:
+    - **Kociemba's Algorithm (Optimal):** Offloads pruning tables and recursive heuristic searches to Web Workers to instantly calculate and stream back the objectively shortest path solution (typically <20 moves).
-```bash
+- **High Performance:** Decoupling the single-threaded UI rendering stack from mathematical validations ensures 60 FPS 3D animations, even while executing computationally expensive analytical algorithms in the background.
-docker network create npm_public
-```
-(Jeśli Twój Nginx Proxy Manager używa innej sieci, zaktualizuj nazwę w `docker-compose.yml`).
-
-W panelu Nginx Proxy Manager skonfiguruj:
-*   **Network:** `npm_public` (lub odpowiednia sieć proxy).
-*   **Forward Hostname:** `rubic-cube`
-*   **Forward Port:** `80`

package.json

@@ -15,6 +15,7 @@
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^5.2.1",
+    "puppeteer": "^24.37.5",
     "vite": "^6.2.0"
   }
 }