Skip to content

Commit 1774378

Browse files
committed
Update readme
1 parent 61942ea commit 1774378

File tree

3 files changed

+29
-29
lines changed

3 files changed

+29
-29
lines changed

packages/powersync/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Our [full SDK reference](https://docs.powersync.com/client-sdk-references/flutte
2222

2323
## **Web support - Open alpha**
2424

25-
Web support in version 1.6.0 is currently in its alpha stage. This README has been updated to reflect changes relevant to this alpha release.
25+
Web support in version ^1.6.0 is currently in its alpha stage. This README has been updated to reflect changes relevant to this alpha release.
2626

2727
### Demo app
2828

@@ -42,7 +42,7 @@ The easiest way to test out the alpha is to run the [Supabase Todo-List](./demos
4242
Install the latest version of the package, for example:
4343

4444
```
45-
flutter pub add powersync:'^1.6.0'
45+
flutter pub add powersync:'^1.8.7'
4646
```
4747

4848
The latest version can be found [here](https://pub.dev/packages/powersync/versions).

packages/powersync_core/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ This package (`powersync_core`) is the PowerSync client SDK for Dart.
1111
> **Note**
1212
>
1313
> This is a Dart library for Powersync for use cases such as server-side Dart or non-Flutter Dart environments.
14+
> This library requires sqlite3 with extension loading enabled to be installed on your system.
1415
>
1516
> If you are developing a Flutter application, use [powersync](https://pub.dev/packages/powersync) or [powersync_sqlcipher](https://pub.dev/packages/powersync_sqlcipher) instead. The `powersync_core` package is for non-Flutter Dart environments.
1617
@@ -19,3 +20,17 @@ This package (`powersync_core`) is the PowerSync client SDK for Dart.
1920
```bash
2021
dart pub add powersync_core
2122
```
23+
24+
# Changelog
25+
26+
A changelog for this SDK is available [here](https://pub.dev/packages/powersync_core/changelog).
27+
28+
# API Reference
29+
30+
The full API reference for this SDK can be found [here](https://pub.dev/documentation/powersync_core/latest/powersync_core/powersync_core-library.html).
31+
32+
# Found a bug or need help?
33+
34+
- Join our [Discord server](https://discord.gg/powersync) where you can browse topics from our community, ask questions, share feedback, or just say hello :)
35+
- Please open a [GitHub issue](https://github.com/powersync-ja/powersync.dart/issues) when you come across a bug.
36+
- 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/powersync-chat) with someone from our product team.

packages/powersync_sqlcipher/README.md

Lines changed: 12 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
_[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)._
88

9-
This package (`powersync_sqlcipher`) is the PowerSync client SDK for Dart/Flutter with encryption enabled using SQLCipher.
9+
This package (`powersync_sqlcipher`) is the PowerSync client SDK for Flutter with encryption enabled using SQLCipher.
1010

1111
# Installation
1212

@@ -18,7 +18,15 @@ flutter pub add powersync_sqlcipher
1818

1919
Our [full SDK reference](https://docs.powersync.com/client-sdk-references/flutter) contains everything you need to know to get started implementing PowerSync in your project.
2020

21-
This SDK requires a slightly different setup in order to encrypt the local database.
21+
### Installing PowerSync with SQLCipher encryption in your own project
22+
23+
Install the latest version of the package, for example:
24+
25+
```
26+
flutter pub add powersync_sqlcipher
27+
```
28+
29+
This SDK requires a slightly different setup to powersync in order to encrypt the local database.
2230

2331
### Usage
2432

@@ -34,38 +42,15 @@ final cipherFactory = PowerSyncSQLCipherOpenFactory(
3442
db = PowerSyncDatabase.withFactory(cipherFactory, schema: schema);
3543
```
3644

37-
### Installing PowerSync in your own project
38-
39-
Install the latest version of the package, for example:
40-
41-
```
42-
flutter pub add powersync_sqlcipher
43-
```
44-
4545
The latest version can be found [here](https://pub.dev/packages/powersync_sqlcipher/versions).
4646

47-
### Demo app
48-
49-
The easiest way to test out the powersync is to run the [Supabase Todo-List](./demos/supabase-todolist) demo app:
50-
51-
1. Checkout [this repo's](https://github.com/powersync-ja/powersync.dart/tree/master) `master` branch.
52-
53-
- Note: If you are an existing user updating to the latest code after a git pull, run `melos exec 'flutter pub upgrade'` in the repo's root and make sure it succeeds.
54-
55-
2. Run `melos prepare` in the repo's root
56-
3. cd into the `demos/supabase-todolist` folder
57-
4. If you haven’t yet: `cp lib/app_config_template.dart lib/app_config.dart` (optionally update this config with your own Supabase and PowerSync project details).
58-
5. Run `flutter run -d chrome`
59-
60-
[comment]: # "The sections below need to be updated"
61-
6247
# Changelog
6348

64-
A changelog for this SDK is available [here](https://releases.powersync.com/announcements/flutter-client-sdk).
49+
A changelog for this SDK is available [here](https://pub.dev/packages/powersync_sqlcipher/changelog).
6550

6651
# API Reference
6752

68-
The full API reference for this SDK can be found [here](https://pub.dev/documentation/powersync/latest/powersync/powersync-library.html).
53+
The full API reference for this SDK can be found [here](https://pub.dev/documentation/powersync_sqlcipher/latest/powersync_sqlcipher/powersync_sqlcipher-library.html).
6954

7055
# Examples
7156

0 commit comments

Comments
 (0)