Skip to content

Commit 5d135bf

Browse files
committed
Readme polish
1 parent 38c2729 commit 5d135bf

File tree

3 files changed

+16
-36
lines changed

3 files changed

+16
-36
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@
3434

3535
- Kysely integration (ORM) for React Native and JavaScript/TypeScript projects.
3636

37+
- [packages/powersync-op-sqlite](./packages/powersync-op-sqlite/README.md)
38+
39+
- OP-SQLite integration for React Native projects.
40+
3741
- [packages/common](./packages/common/README.md)
3842
- Shared package: TypeScript implementation of a PowerSync database connector and streaming sync bucket implementation.
3943

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
<p align="center">
2-
<a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/7372448/d2538c43-c1a0-4c47-9a76-41462dba484f"/></a>
3-
</p>
1+
# OP-SQLite Factory for the PowerSync React Native SDK
42

5-
# PowerSync SDK for React Native
3+
## Overview
64

7-
_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres or MongoDB on the server-side (MySQL coming soon)._
5+
This package (`packages/powersync-op-sqlite`) enables using [OP-SQLite](https://github.com/op-engineering/op-sqlite) with PowerSync alongside the [React Native SDK](../react-native/README.md).
86

9-
This package (`packages/powersync-op-sqlite`) enables using OP-SQLite with PowerSync. It is an extension of `packages/common`.
7+
If you are not yet familiar with PowerSync, please see the [PowerSync React Native SDK](../react-native/README.md) for more information.
108

11-
## Alpha release
9+
### Alpha release
1210

1311
This package is currently in an alpha release. If you find a bug or issue, please open a [GitHub issue](https://github.com/powersync-ja/powersync-js/issues). Questions or feedback can be posted on our [community Discord](https://discord.gg/powersync) - we'd love to hear from you.
1412

15-
# Installation
13+
## Installation
1614

17-
## Install Package
15+
Follow the installation instructions for the [React Native SDK](../react-native/README.md) if you haven't yet set up PowerSync in your project. However, note that this package cannot be installed alongside `@journeyapps/react-native-quick-sqlite`. Skip the step about installing it as a peer dependency, or uninstall it if it is already installed.
16+
17+
### Install Package
1818

1919
```bash
2020
npx expo install @powersync/op-sqlite
2121
```
2222

23-
## Install Peer Dependency: SQLite
23+
### Install Peer Dependency:
2424

2525
This SDK currently requires `@op-engineering/op-sqlite` as a peer dependency.
2626

@@ -30,8 +30,6 @@ Install it in your app with:
3030
npx expo install @op-engineering/op-sqlite
3131
```
3232

33-
**Note**: This package cannot be installed alongside `@journeyapps/react-native-quick-sqlite`. Please ensure you do **not** install both packages at the same time.
34-
3533
## Usage
3634

3735
```typescript
@@ -45,7 +43,7 @@ const factory = new OPSqliteOpenFactory({
4543
this.powersync = new PowerSyncDatabase({ database: factory, schema: AppSchema });
4644
```
4745

48-
# Native Projects
46+
## Native Projects
4947

5048
This package uses native libraries. Create native Android and iOS projects (if not created already) by running:
5149

@@ -54,25 +52,3 @@ npx expo run:android
5452
# OR
5553
npx expo run:ios
5654
```
57-
58-
# Getting Started
59-
60-
Our [SDK reference](https://docs.powersync.com/client-sdk-references/react-native-and-expo) contains everything you need to know to get started implementing PowerSync in your project.
61-
62-
# Changelog
63-
64-
A changelog for this SDK is available [here](https://releases.powersync.com/announcements/react-native-client-sdk).
65-
66-
# API Reference
67-
68-
The full API reference for this SDK can be found [here](https://powersync-ja.github.io/powersync-js/react-native-sdk).
69-
70-
# Examples
71-
72-
For example projects built with PowerSync and React Native, see our [Demo Apps / Example Projects](https://docs.powersync.com/resources/demo-apps-example-projects#react-native-and-expo) gallery. Most of these projects can also be found in the [`demos/`](../demos/) directory.
73-
74-
# Found a bug or need help?
75-
76-
- Join our [Discord server](https://discord.gg/powersync) where you can browse topics from our community, ask questions, share feedback, or just say hello :)
77-
- Please open a [GitHub issue](https://github.com/powersync-ja/powersync-js/issues) when you come across a bug.
78-
- Have feedback or an idea? [Submit an idea](https://roadmap.powersync.com/tabs/5-roadmap/submit-idea) via our public roadmap or [schedule a chat](https://calendly.com/powersync-product/powersync-chat) with someone from our product team.

packages/react-native/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ npx expo install @powersync/react-native
2020

2121
## Install Peer Dependency: SQLite
2222

23-
This SDK currently requires `@journeyapps/react-native-quick-sqlite` as a peer dependency.
23+
By default, this SDK requires `@journeyapps/react-native-quick-sqlite` as a peer dependency. Alternatively, you can install OP-SQLite from the [PowerSync OP-SQLite package](../powersync-op-sqlite/README.md) (currently in alpha).
2424

2525
Install it in your app with:
2626

0 commit comments

Comments
 (0)