You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/powersync_core/README.md
+15Lines changed: 15 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@ This package (`powersync_core`) is the PowerSync client SDK for Dart.
11
11
> **Note**
12
12
>
13
13
> 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.
14
15
>
15
16
> 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.
16
17
@@ -19,3 +20,17 @@ This package (`powersync_core`) is the PowerSync client SDK for Dart.
19
20
```bash
20
21
dart pub add powersync_core
21
22
```
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.
Copy file name to clipboardExpand all lines: packages/powersync_sqlcipher/README.md
+12-27Lines changed: 12 additions & 27 deletions
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
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)._
8
8
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.
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.
20
20
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.
22
30
23
31
### Usage
24
32
@@ -34,38 +42,15 @@ final cipherFactory = PowerSyncSQLCipherOpenFactory(
34
42
db = PowerSyncDatabase.withFactory(cipherFactory, schema: schema);
35
43
```
36
44
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
-
45
45
The latest version can be found [here](https://pub.dev/packages/powersync_sqlcipher/versions).
46
46
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:
- 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
-
62
47
# Changelog
63
48
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).
65
50
66
51
# API Reference
67
52
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).
0 commit comments