diff --git a/README.md b/README.md index ac08095..f06842e 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,92 @@ # KoalaSync -[![Release](https://github.com/Shik3i/KoalaSync/actions/workflows/release.yml/badge.svg)](https://github.com/Shik3i/KoalaSync/actions/workflows/release.yml) -[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Shik3i/KoalaSync)](https://github.com/Shik3i/KoalaSync/releases) +
+ KoalaSync Banner -KoalaSync is a premium, lightweight Browser Extension and Relay Server for synchronized video playback across any website (YouTube, Twitch, Netflix, and custom HTML5 players). +

+ Privacy-First, Zero-Dependency Synchronized Video Playback for Modern Browsers. +

-**Latest Release**: [GitHub Releases](https://github.com/Shik3i/KoalaSync/releases) +

+ Release Status + GitHub release + License +
+ Zero Dependencies + Privacy Focused + Manifest V3 + Cross Browser +

+
-> [!TIP] -> **New Developers & AI Agents**: Please read [AI_INIT.md](AI_INIT.md) before starting work. +--- -## Repository Structure -- `extension/`: Chrome Extension (Manifest V3, Vanilla JS). -- `server/`: Node.js + Socket.IO Relay Server (Containerized). -- `website/`: Marketing landing page & **Invitation Bridge**. -- `shared/`: Protocol constants and domain blacklist. -- `scripts/`: Development utilities (Build & Sync). -- `docs/`: Technical documentation ([ARCHITECTURE.md](docs/ARCHITECTURE.md), [SYNC_GUIDE.md](docs/SYNC_GUIDE.md)). +KoalaSync is a premium, lightweight Browser Extension and Relay Server for synchronized video playback across any websiteโ€”YouTube, Twitch, Netflix, and custom HTML5 players. Built with a focus on **Data Sovereignty** and **Extreme Performance**. -## ๐Ÿ”’ Privacy & Security -KoalaSync is built for users who value privacy. -- **Zero Collection**: We do not collect or sell your data. -- **Zero Telemetry**: No analytics or tracking scripts. -- **Zero Dependencies**: The extension uses 100% Vanilla JS for maximum security. -- **Self-Hostable**: Full Docker support for private relay servers. -See [PRIVACY.md](PRIVACY.md) for our full commitment. +### ๐ŸŒŸ Why KoalaSync? + +* **๐Ÿ›ก๏ธ Privacy First**: Zero external requests. No Google Fonts, no CDNs, and absolutely no telemetry or data collection. +* **โšก Zero-Latency**: Native implementation of the Socket.IO v4 wire protocol for frame-perfect synchronization. +* **๐Ÿ“ฆ Zero Dependencies**: The extension is built with pure Vanilla JS. No heavy frameworks or third-party libraries. +* **๐Ÿ  Self-Hostable**: Own your data. Deploy your own relay server in seconds using Docker. + +--- + +### โœจ Key Features -## Key Features - **Global Synchronization**: Synchronize Play, Pause, and Seeking on any website with a `