From 4c4a2638d7104366e5af31ab8b8220c84bc34757 Mon Sep 17 00:00:00 2001 From: Koala <6156589+Shik3i@users.noreply.github.com> Date: Mon, 25 May 2026 23:06:58 +0200 Subject: [PATCH] docs: rearrange README to prioritize user quick start --- README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d2b8396..0c1a9bb 100644 --- a/README.md +++ b/README.md @@ -30,17 +30,6 @@ --- -### 📂 Repository Structure - -- `extension/`: Browser Extension (Chrome & Firefox). -- `server/`: Node.js + Socket.IO Relay Server (Containerized). -- `website/`: Marketing landing page & Invitation Bridge. -- `shared/`: **Single Source of Truth** for protocol constants. -- `scripts/`: Automated build and synchronization utilities. -- `docs/`: Technical deep-dives ([Architecture](docs/ARCHITECTURE.md), [Sync Guide](docs/SYNC_GUIDE.md)). - ---- - ### 🚀 Quick Start #### For Users (Installation & Usage) @@ -58,7 +47,20 @@ The easiest and safest way to install KoalaSync is directly through the official 2. **Invite Friends:** Share the auto-copied invite link. Once they click it, they automatically join. 3. **Pick a Video:** Navigate to the Sync Tab, select the tab playing your video, and grab some popcorn! 🍿 -#### For Developers (Building) +--- + +### 🛠️ For Developers & Self-Hosters + +#### 📂 Repository Structure + +- `extension/`: Browser Extension (Chrome & Firefox). +- `server/`: Node.js + Socket.IO Relay Server (Containerized). +- `website/`: Marketing landing page & Invitation Bridge. +- `shared/`: **Single Source of Truth** for protocol constants. +- `scripts/`: Automated build and synchronization utilities. +- `docs/`: Technical deep-dives ([Architecture](docs/ARCHITECTURE.md), [Sync Guide](docs/SYNC_GUIDE.md)). + +#### Building from Source To build the extension from source and synchronize protocol constants: ```bash npm install