Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stevensJourney committed Nov 14, 2023
1 parent 240e402 commit cadb5ed
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions packages/powersync-sdk-web/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PowerSync SDK for Web

[PowerSync](https://powersync.co) is a service and set of SDKs that keeps Postgres databases in sync with on-device SQLite databases. See a summary of features [here](https://docs.powersync.co/client-sdk-references/react-native-and-expo).
[PowerSync](https://powersync.co) is a service and set of SDKs that keeps Postgres databases in sync with on-device SQLite databases.

## Alpha Release
This SDK package is currently in an alpha release.
Expand Down Expand Up @@ -98,4 +98,10 @@ export const connectPowerSync = async () => {

React hooks are available in the [@journeyapps/powersync-react](https://www.npmjs.com/package/@journeyapps/powersync-react) package

Refer to our [full documentation](https://docs.powersync.co/client-sdk-references/react-native-and-expo) to learn more.

## Demo Apps

See our [NextJS Demo App](https://github.com/powersync-ja/powersync-web-sdk/tree/main/demos/powersync-nextjs-demo) for how to use this SDK with NextJS.

# Known Issues
This initial SDK uses a `SharedWorker` for DB operations. This is not supported on Chrome for Android. Future SDK versions will feature selectable DB Adapters which will increase compatibility.

0 comments on commit cadb5ed

Please sign in to comment.