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_sqlcipher/README.md
+10-12Lines changed: 10 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,30 +6,26 @@
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 Flutter with encryption enabled using SQLCipher.
9
+
This package (`powersync_sqlcipher`) is the PowerSync client SDK for Flutter with encryption enabled using SQLCipher.
10
10
11
-
# Installation
11
+
If you do not require encryption, we recommend using the [`powersync`](/packages/powersync/README.md) SDK.
12
12
13
-
```bash
14
-
flutter pub add powersync_sqlcipher
15
-
```
16
-
17
-
# Getting Started
18
-
19
-
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
13
21
14
### Installing PowerSync with SQLCipher encryption in your own project
22
15
23
16
Install the latest version of the package, for example:
24
17
25
-
```
18
+
```bash
26
19
flutter pub add powersync_sqlcipher
27
20
```
28
21
29
-
This SDK requires a slightly different setup to powersync in order to encrypt the local database.
22
+
Version history can be found [here](https://pub.dev/packages/powersync_sqlcipher/versions).
30
23
24
+
)
31
25
### Usage
32
26
27
+
This SDK requires a slightly different setup to the `powersync` package in order to encrypt the local database:
@@ -42,7 +38,9 @@ final cipherFactory = PowerSyncSQLCipherOpenFactory(
42
38
db = PowerSyncDatabase.withFactory(cipherFactory, schema: schema);
43
39
```
44
40
45
-
The latest version can be found [here](https://pub.dev/packages/powersync_sqlcipher/versions).
41
+
# Getting Started
42
+
43
+
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.
0 commit comments