Replace default README and add license

This commit is contained in:
2025-10-03 22:20:14 +02:00
parent ba91280b35
commit 0be90d06a6
2 changed files with 53 additions and 8 deletions

View File

@@ -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`).
2. Open Chrome and go to `chrome://extensions`.
3. Toggle **Developer mode** on (top-right).
4. Click **Load unpacked** and pick the extension folder.
5. The extension should appear in the toolbar (pin it for convenience).
## 🚀 Features
-**Bookmark Syncing**: Automatically sync bookmarks between your Chrome browsers.
- 🔐 **Token-Based Syncing**: Your data is linked to a unique **sync token**—share it with other devices to sync across them.
- 🌐 **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.)