Skip to content

Updated readme to explain fork existence. #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 30, 2025
Merged

Updated readme to explain fork existence. #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07ada74
Updated readme to explain fork existence.
Chriztiaan Jul 30, 2025
89604d4
Minor wording.
Chriztiaan Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# PowerSync SQL.js

This is a minor fork of SQL.js which includes PowerSync.
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.

- No native dependencies required
- Optimized for rapid prototyping and development workflows
- Universal compatibility

> **Note:** This implementation is intended for development only. For production use, consider native adapters that offer better performance and data integrity guarantees.

## Why a fork?

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).
Loading