Update readme

powersync-ja · Oct 23, 2024 · 1774378 · 1774378
1 parent 61942ea
commit 1774378
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 29 deletions.
diff --git a/packages/powersync/README.md b/packages/powersync/README.md
@@ -22,7 +22,7 @@ Our [full SDK reference](https://docs.powersync.com/client-sdk-references/flutte
 
 ## **Web support - Open alpha**
 
-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.
+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.
 
 ### Demo app
 
@@ -42,7 +42,7 @@ The easiest way to test out the alpha is to run the [Supabase Todo-List](./demos
 Install the latest version of the package, for example:
 
 ```
-flutter pub add powersync:'^1.6.0'
+flutter pub add powersync:'^1.8.7'
 ```
 
 The latest version can be found [here](https://pub.dev/packages/powersync/versions).

diff --git a/packages/powersync_core/README.md b/packages/powersync_core/README.md
@@ -11,6 +11,7 @@ This package (`powersync_core`) is the PowerSync client SDK for Dart.
 > **Note**
 >
 > This is a Dart library for Powersync for use cases such as server-side Dart or non-Flutter Dart environments.
+> This library requires sqlite3 with extension loading enabled to be installed on your system.
 >
 > 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.
 
@@ -19,3 +20,17 @@ This package (`powersync_core`) is the PowerSync client SDK for Dart.
 ```bash
 dart pub add powersync_core
 ```
+
+# Changelog
+
+A changelog for this SDK is available [here](https://pub.dev/packages/powersync_core/changelog).
+
+# API Reference
+
+The full API reference for this SDK can be found [here](https://pub.dev/documentation/powersync_core/latest/powersync_core/powersync_core-library.html).
+
+# Found a bug or need help?
+
+- Join our [Discord server](https://discord.gg/powersync) where you can browse topics from our community, ask questions, share feedback, or just say hello :)
+- Please open a [GitHub issue](https://github.com/powersync-ja/powersync.dart/issues) when you come across a bug.
+- 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.
diff --git a/packages/powersync_sqlcipher/README.md b/packages/powersync_sqlcipher/README.md
@@ -6,7 +6,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)._
 
-This package (`powersync_sqlcipher`) is the PowerSync client SDK for Dart/Flutter with encryption enabled using SQLCipher.
+This package (`powersync_sqlcipher`) is the PowerSync client SDK for Flutter with encryption enabled using SQLCipher.
 
 # Installation
 
@@ -18,7 +18,15 @@ flutter pub add powersync_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.
 
-This SDK requires a slightly different setup in order to encrypt the local database.
+### Installing PowerSync with SQLCipher encryption in your own project
+
+Install the latest version of the package, for example:
+
+```
+flutter pub add powersync_sqlcipher
+```
+
+This SDK requires a slightly different setup to powersync in order to encrypt the local database.
 
 ### Usage
 
@@ -34,38 +42,15 @@ final cipherFactory = PowerSyncSQLCipherOpenFactory(
 db = PowerSyncDatabase.withFactory(cipherFactory, schema: schema);
 ```
 
-### Installing PowerSync in your own project
-
-Install the latest version of the package, for example:
-
-```
-flutter pub add powersync_sqlcipher
-```
-
 The latest version can be found [here](https://pub.dev/packages/powersync_sqlcipher/versions).
 
-### Demo app
-
-The easiest way to test out the powersync is to run the [Supabase Todo-List](./demos/supabase-todolist) demo app:
-
-1. Checkout [this repo's](https://github.com/powersync-ja/powersync.dart/tree/master) `master` branch.
-
-- 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.
-
-2. Run `melos prepare` in the repo's root
-3. cd into the `demos/supabase-todolist` folder
-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).
-5. Run `flutter run -d chrome`
-
-[comment]: # "The sections below need to be updated"
-
 # Changelog
 
-A changelog for this SDK is available [here](https://releases.powersync.com/announcements/flutter-client-sdk).
+A changelog for this SDK is available [here](https://pub.dev/packages/powersync_sqlcipher/changelog).
 
 # API Reference
 
-The full API reference for this SDK can be found [here](https://pub.dev/documentation/powersync/latest/powersync/powersync-library.html).
+The full API reference for this SDK can be found [here](https://pub.dev/documentation/powersync_sqlcipher/latest/powersync_sqlcipher/powersync_sqlcipher-library.html).
 
 # Examples