Skip to content

Commit 5ebcd6e

Browse files
committed
chore: update docs and references to main repo
1 parent 3f20878 commit 5ebcd6e

File tree

6 files changed

+11
-144
lines changed

6 files changed

+11
-144
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,10 +191,10 @@ sqlite3_close(db)
191191

192192
### Android Package
193193

194-
Add the [following](https://central.sonatype.com/artifact/ai.sqlite/sync.dev) to your Gradle dependencies:
194+
Add the [following](https://central.sonatype.com/artifact/ai.sqlite/sync) to your Gradle dependencies:
195195

196196
```gradle
197-
implementation 'ai.sqlite:sync.dev:0.9.92'
197+
implementation 'ai.sqlite:sync:1.0.0'
198198
```
199199

200200
Here's an example of how to use the package:

docs/postgresql/CLIENT.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,6 @@ Under the hood, SQLite Sync uses advanced **CRDT (Conflict-free Replicated Data
1010
- When they reconnect, all changes are **merged automatically and without conflicts**.
1111
- **No data loss. No overwrites. No manual conflict resolution.**
1212

13-
## IMPORTANT
14-
15-
- Make sure to use version **0.9.96 or newer**
16-
(verify with `SELECT cloudsync_version();`)
17-
18-
- Until v0.9.96 is released upstream, always use the development fork:
19-
https://github.com/sqliteai/sqlite-sync-dev
20-
and **NOT** the original repository:
21-
https://github.com/sqliteai/sqlite-sync
22-
23-
- Updated example apps are available [here](https://github.com/sqliteai/sqlite-sync-dev/tree/main/examples):
24-
- sport-tracker app (WASM), see [SPORT_APP_README_SUPABASE.md](SPORT_APP_README_SUPABASE.md) for more details
25-
- to-do app (Expo), see [EXPO.md](EXPO.md) for more details
26-
- React Native Library: https://github.com/sqliteai/sqlite-sync-react-native
27-
2813
## Conversion Between SQLite and PostgreSQL Tables
2914

3015
In this version, make sure to **manually create** the same tables in the PostgreSQL database as used in the SQLite client.
@@ -142,11 +127,11 @@ SELECT cloudsync_init('notes');
142127
- [ ] Same column names and order
143128
- [ ] Same defaults (semantic match)
144129

145-
Please follow [these Database Schema Recommendations](https://github.com/sqliteai/sqlite-sync-dev?tab=readme-ov-file#database-schema-recommendations)
130+
Please follow [these Database Schema Recommendations](https://github.com/sqliteai/sqlite-sync?tab=readme-ov-file#database-schema-recommendations)
146131

147132
## Pre-built Binaries
148133

149-
Download the appropriate pre-built binary for your platform from the official [Releases](https://github.com/sqliteai/sqlite-sync-dev/releases) page:
134+
Download the appropriate pre-built binary for your platform from the official [Releases](https://github.com/sqliteai/sqlite-sync/releases) page:
150135

151136
- Linux: x86 and ARM
152137
- macOS: x86 and ARM
@@ -166,9 +151,8 @@ SELECT load_extension('./cloudsync');
166151

167152
## WASM Version -> React client-side
168153

169-
Make sure to install the extension tagged as **dev** and not **latest**
170154
```
171-
npm i @sqliteai/sqlite-wasm@dev
155+
npm i @sqliteai/sqlite-wasm
172156
```
173157

174158
Then follow the instructions from the [README](https://www.npmjs.com/package/@sqliteai/sqlite-wasm)
@@ -179,10 +163,10 @@ You can [add this repository as a package dependency to your Swift project](http
179163

180164
## Android Package
181165

182-
Add the [following](https://central.sonatype.com/artifact/ai.sqlite/sync.dev) to your Gradle dependencies:
166+
Add the [following](https://central.sonatype.com/artifact/ai.sqlite/sync) to your Gradle dependencies:
183167

184168
```
185-
implementation 'ai.sqlite:sync.dev:0.9.96'
169+
implementation 'ai.sqlite:sync:1.0.0'
186170
```
187171

188172
## Expo
@@ -209,9 +193,9 @@ Then follow the instructions from the [README](https://www.npmjs.com/package/@sq
209193

210194
```js
211195
npm i better-sqlite3
212-
npm i @sqliteai/sqlite-sync-dev
196+
npm i @sqliteai/sqlite-sync
213197

214-
echo "import { getExtensionPath } from '@sqliteai/sqlite-sync-dev';
198+
echo "import { getExtensionPath } from '@sqliteai/sqlite-sync';
215199
import Database from 'better-sqlite3';
216200
217201
const db = new Database(':memory:');

docs/postgresql/CLOUDSYNC.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/postgresql/EXPO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ ANDROID_CONNECTION_STRING="http://10.0.2.2:8091/postgres"
3333
API_TOKEN="token"
3434
```
3535
36-
5. Fill the `API_TOKEN` variable with the access token from the [`CloudSync`](CLOUDSYNC.md) service.
36+
5. Fill the `API_TOKEN` variable with the access token.
3737
3838
> **⚠️ SECURITY WARNING**: This example puts database connection strings directly in `.env` files for demonstration purposes only. **Do not use this pattern in production.**
3939
>

docs/postgresql/README.md

Lines changed: 0 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -16,49 +16,6 @@ We provide prebuilt binaries for:
1616
* WebAssembly (WASM)
1717
* Popular package managers and frameworks including React Native, Expo, Node, Swift PM and Android AAR
1818

19-
**Note:** The latest version (v0.9.96) is not yet available in the official SQLite Sync repository. Please use our development fork instead: [https://github.com/sqliteai/sqlite-sync-dev](https://github.com/sqliteai/sqlite-sync-dev)
20-
21-
<details>
22-
<summary>List of development fork binaries (v0.9.96)</summary>
23-
24-
### Android
25-
- [cloudsync-android-aar-0.9.96.aar](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-android-aar-0.9.96.aar)
26-
- [cloudsync-android-arm64-v8a-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-android-arm64-v8a-0.9.96.tar.gz)
27-
- [cloudsync-android-arm64-v8a-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-android-arm64-v8a-0.9.96.zip)
28-
- [cloudsync-android-armeabi-v7a-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-android-armeabi-v7a-0.9.96.tar.gz)
29-
- [cloudsync-android-armeabi-v7a-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-android-armeabi-v7a-0.9.96.zip)
30-
- [cloudsync-android-x86_64-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-android-x86_64-0.9.96.tar.gz)
31-
- [cloudsync-android-x86_64-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-android-x86_64-0.9.96.zip)
32-
33-
### Apple (iOS / macOS)
34-
- [cloudsync-apple-xcframework-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-apple-xcframework-0.9.96.zip)
35-
- [cloudsync-ios-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-ios-0.9.96.tar.gz)
36-
- [cloudsync-ios-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-ios-0.9.96.zip)
37-
- [cloudsync-ios-sim-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-ios-sim-0.9.96.tar.gz)
38-
- [cloudsync-ios-sim-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-ios-sim-0.9.96.zip)
39-
- [cloudsync-macos-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-macos-0.9.96.tar.gz)
40-
- [cloudsync-macos-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-macos-0.9.96.zip)
41-
- [cloudsync-macos-arm64-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-macos-arm64-0.9.96.tar.gz)
42-
- [cloudsync-macos-arm64-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-macos-arm64-0.9.96.zip)
43-
- [cloudsync-macos-x86_64-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-macos-x86_64-0.9.96.tar.gz)
44-
- [cloudsync-macos-x86_64-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-macos-x86_64-0.9.96.zip)
45-
46-
### Linux
47-
- [cloudsync-linux-arm64-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-linux-arm64-0.9.96.tar.gz)
48-
- [cloudsync-linux-arm64-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-linux-arm64-0.9.96.zip)
49-
- [cloudsync-linux-musl-arm64-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-linux-musl-arm64-0.9.96.tar.gz)
50-
- [cloudsync-linux-musl-arm64-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-linux-musl-arm64-0.9.96.zip)
51-
- [cloudsync-linux-musl-x86_64-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-linux-musl-x86_64-0.9.96.tar.gz)
52-
- [cloudsync-linux-musl-x86_64-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-linux-musl-x86_64-0.9.96.zip)
53-
- [cloudsync-linux-x86_64-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-linux-x86_64-0.9.96.tar.gz)
54-
- [cloudsync-linux-x86_64-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-linux-x86_64-0.9.96.zip)
55-
56-
### Windows
57-
- [cloudsync-windows-x86_64-0.9.96.tar.gz](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-windows-x86_64-0.9.96.tar.gz)
58-
- [cloudsync-windows-x86_64-0.9.96.zip](https://github.com/sqliteai/sqlite-sync-dev/releases/download/0.9.96/cloudsync-windows-x86_64-0.9.96.zip)
59-
60-
</details>
61-
6219
### Architecture Refactoring
6320
The extension has been refactored to support both **SQLite** and **PostgreSQL** backends.
6421
* All database-specific native calls have been isolated in [database.h](../../src/database.h)
@@ -112,13 +69,6 @@ Additional CRDTs can be implemented if needed, though LWW covers most real-world
11269

11370
* Metrics dashboard available in [grafana-dashboard.json](grafana-dashboard.json)
11471

115-
* Additional logs available via the Fly.io monitoring dashboard
116-
117-
### Demo Deployment
118-
119-
For the current demo, a single CloudSync node is deployed in **Europe** on Fly.io.
120-
If testing from other regions, latency will reflect this single-node deployment. A production deployment would use **geographically distributed nodes with regional routing** for global coverage.
121-
12272

12373
# Postgres Sync
12474

@@ -143,13 +93,10 @@ This preserves PostgreSQL-native organization while maintaining SQLite compatibi
14393

14494
The PostgreSQL integration is actively evolving. Current limitations include:
14595

146-
* **User Impersonation**: The microservice currently applies server changes using the Supabase Admin user. In the next version, changes will be applied under the identity associated with the client’s JWT.
14796
* **Table Creation**: Tables must currently be created manually in PostgreSQL before synchronization. We are implementing automatic translation of SQLite CREATE TABLE statements to PostgreSQL syntax.
148-
* **Row-Level Security**: RLS is fully implemented for SQLite Cloud servers. PostgreSQL RLS integration is in progress and will be included in the final release.
14997
* **Beta Status**: While extensively tested, the PostgreSQL sync stack should currently be considered **beta software**. Please report any issues; we are committed to resolving them quickly.
15098

15199
# Next
152100
* [CLIENT](CLIENT.md) installation and setup
153-
* [CLOUDSYNC](CLOUDSYNC.md) microservice configuration and setup
154101
* [SUPABASE](SUPABASE.md) configuration and setup
155102
* [SPORT-TRACKER APP](SPORT_APP_README_SUPABASE.md) demo web app based on SQLite Sync WASM

examples/sport-tracker-app/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"vite": "^7.0.0"
1414
},
1515
"dependencies": {
16-
"@sqliteai/sqlite-wasm": "dev",
16+
"@sqliteai/sqlite-wasm": "*",
1717
"@types/react": "^19.1.8",
1818
"@types/react-dom": "^19.1.6",
1919
"@vitejs/plugin-react": "^4.6.0",

0 commit comments

Comments
 (0)