Skip to content

Commit d4f159f

Browse files
committed
Readme polish
1 parent 1774378 commit d4f159f

File tree

2 files changed

+11
-13
lines changed

2 files changed

+11
-13
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# powersync_flutter_libs
22

3-
### Flutter binaries for [PowerSync](https://pub.dev/packages/powersync) please go there for documentation.
3+
### Flutter binaries for [PowerSync](https://pub.dev/packages/powersync). Please go there for documentation.
44

55
#### The core PowerSync binaries are built and released in [powersync-sqlite-core](https://github.com/powersync-ja/powersync-sqlite-core).

packages/powersync_sqlcipher/README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,26 @@
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 Flutter with encryption enabled using SQLCipher.
9+
This package (`powersync_sqlcipher`) is the PowerSync client SDK for Flutter with encryption enabled using SQLCipher.
1010

11-
# Installation
11+
If you do not require encryption, we recommend using the [`powersync`](/packages/powersync/README.md) SDK.
1212

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.
2013

2114
### Installing PowerSync with SQLCipher encryption in your own project
2215

2316
Install the latest version of the package, for example:
2417

25-
```
18+
```bash
2619
flutter pub add powersync_sqlcipher
2720
```
2821

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).
3023

24+
)
3125
### Usage
3226

27+
This SDK requires a slightly different setup to the `powersync` package in order to encrypt the local database:
28+
3329
```Dart
3430
import 'package/powersync_sqlcipher/powersync.dart';
3531
@@ -42,7 +38,9 @@ final cipherFactory = PowerSyncSQLCipherOpenFactory(
4238
db = PowerSyncDatabase.withFactory(cipherFactory, schema: schema);
4339
```
4440

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.
4644

4745
# Changelog
4846

0 commit comments

Comments
 (0)