Skip to content

Commit a46f3db

Browse files
authored
Merge pull request #4 from powersync-ja/chore/readme-updates
Updated readme to explain fork existence.
2 parents 6292169 + 89604d4 commit a46f3db

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
11
# PowerSync SQL.js
22

3-
This is a minor fork of SQL.js which includes PowerSync.
3+
A fork of SQL.js (SQLite compiled to JavaScript via Emscripten) that loads the PowerSync's [Rust core extension](https://github.com/powersync-ja/powersync-sqlite-core). This allows PowerSync functionality in environments where native dependencies cannot be used.
44

5+
- No native dependencies required
6+
- Optimized for rapid prototyping and development workflows
7+
- Universal compatibility
8+
9+
> **Note:** This implementation is intended for development only. For production use, consider native adapters that offer better performance and data integrity guarantees.
10+
11+
## Why a fork?
12+
13+
Beyond loading the core extension, minor additions were needed on top of the SQL.js to be compatible with the PowerSync SDKs (for example functionality to expose `lastInsertId` and enabling `FTS5`). These are applied in the form of [git patches](https://github.com/powersync-ja/powersync-sql-js/tree/main/patches).

0 commit comments

Comments
 (0)