Replace default README and add license

README.md

@@ -1,11 +1,49 @@
-# Starter Chrome Extension
+# 🔄 Simple Sync
 
-A minimal Chrome extension starter (Manifest V3) with a popup, options page, content script and background service worker.
+A lightweight Chrome extension that syncs your browser data—starting with bookmarks—across multiple devices using a unique sync token.
 
-## How to run locally
+---
 
-1. Save the project files to a folder (e.g. `chrome-extension-starter`).
+## 🚀 Features
-2. Open Chrome and go to `chrome://extensions`.
+
-3. Toggle **Developer mode** on (top-right).
+- ✅ **Bookmark Syncing**: Automatically sync bookmarks between your Chrome browsers.
-4. Click **Load unpacked** and pick the extension folder.
+- 🔐 **Token-Based Syncing**: Your data is linked to a unique **sync token**—share it with other devices to sync across them.
-5. The extension should appear in the toolbar (pin it for convenience).
+- 🌐 **Cross-Device Support**: Use the same token on multiple devices to keep them in sync.
+- 🔄 **Real-Time Updates** *(Planned)*: Upcoming support for near-instant sync between devices.
+
+---
+
+## 📦 Installation
+
+1. Clone this repository or download the ZIP:
+    ```bash
+    git clone git@gitlab.com:gdulai/simple-sync.git
+    ```
+
+2. Open Chrome and navigate to `chrome://extensions`.
+
+3. Enable **Developer Mode** (top-right corner).
+
+4. Click **Load unpacked**, then select the project folder.
+
+---
+
+## 🛠 Usage
+
+1. After installing, click the extension icon in your Chrome toolbar.
+
+2. If this is your **first device**, generate a **new sync token**.
+
+3. On any **additional devices**, enter the existing sync token to sync with that dataset.
+
+4. The extension will automatically sync your bookmarks periodically.
+
+---
+
+## 🧪 Development
+
+Built with:
+
+- JavaScript (Vanilla)
+- Chrome Extensions API
+- Web Storage / Cloud Sync Backend (custom or Firebase, etc.)

license

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Gergő Dulai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.