Skip to content

Commit f9173b5

Browse files
authored
Update README.md
1 parent 3543e6b commit f9173b5

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

README.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,32 @@ SQLiteSync is a powerful SQLite extension that provides a local-first experience
66

77
## Key Features
88

9-
- **Local-First Approach**: Work offline with confidence. SQLiteSync ensures data integrity and merges changes effortlessly when devices reconnect.
10-
- **CRDT Algorithms**: Resolve conflicts automatically with proven CRDT techniques, eliminating the need for manual resolution.
11-
- **Lightweight and Efficient**: As a SQLite extension, SQLiteSync retains the minimal overhead and speed SQLite is known for.
12-
- **Flexible Integration**: Add synchronization capabilities to existing SQLite-based applications with minimal modifications.
13-
- **Reliable Data Sharing**: Enable collaboration across devices and users without compromising performance or data consistency.
9+
- **Offline-First by Design**: Works seamlessly even when devices are offline. Changes are queued locally and synced automatically when connectivity is restored.
10+
- **CRDT-Based Conflict Resolution**: Merges updates deterministically and efficiently, ensuring eventual consistency across all replicas without the need for complex merge logic.
11+
- **Embedded Network Layer**: No external libraries or sync servers required. SQLiteSync handles connection setup, message encoding, retries, and state reconciliation internally.
12+
- **Drop-in Simplicity**: Just load the extension into SQLite and start syncing. No need to implement custom protocols or state machines.
13+
- **Efficient and Resilient**: Optimized binary encoding, automatic batching, and robust retry logic make synchronization fast and reliable even on flaky networks.
1414

15-
## Installation
16-
17-
To use SQLiteSync, you need SQLite version 3.x or later.
15+
Whether you're building a mobile app, IoT device, or desktop tool, SQLiteSync simplifies distributed data management and unlocks the full potential of SQLite in decentralized environments.
1816

19-
### Build from Source
17+
## Installation
2018

21-
1. Install dependencies:
19+
### Pre-built Binaries
2220

23-
```bash
24-
#linux
25-
sudo apt-get install -y uuid-dev
26-
```
21+
Download the appropriate pre-built binary for your platform from the official [Releases](https://github.com/sqliteai/sqlite-sync/releases) page:
2722

28-
2. Clone the repository:
23+
- Linux: x86 and ARM
24+
- macOS: x86 and ARM
25+
- Windows: x86
26+
- Android
27+
- iOS
2928

30-
```bash
31-
git clone https://github.com/sqliteai/sqlite-sync.git
32-
cd sqlitesync
33-
```
29+
### Loading the Extension
3430

35-
3. Build the extension:
31+
```sql
32+
-- In SQLite CLI
33+
.load ./js
3634

37-
```bash
38-
make
39-
```
35+
-- In SQL
36+
SELECT load_extension('./cloudsync');
37+
```

0 commit comments

Comments
 (0)