More polish

powersync-ja · Feb 14, 2024 · 3d31de8 · 3d31de8
1 parent 7f68092
commit 3d31de8
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ _Bad connectivity is everywhere, and we're tired of it. PowerSync is on a missio
 
 ## Demo Apps / Example Projects
 
-Demo applications are located in the [`demos/`](./demos/) directory. Also see our [Demo Apps / Example Projects gallery](https://docs.powersync.com/resources/demo-apps-example-projects), which lists all projects by the backend and client-side framework they use.
+Demo applications are located in the [`demos/`](./demos/) directory. Also see our [Demo Apps / Example Projects](https://docs.powersync.com/resources/demo-apps-example-projects) gallery which lists all projects by the backend and client-side framework they use.
 
  - [demos/nextjs-supabase-todolist](./demos/nextjs-supabase-todolist/): A Next.js to-do list example app using the PowerSync Web SDK and a Supabase backend.
  - [demos/yjs-nextjs-supabase-text-collab](./demos/yjs-nextjs-supabase-text-collab/README.md): A Next.js real-time text editing collaboration example app powered by [Yjs](https://github.com/yjs/yjs) CRDTs and [Tiptap](https://tiptap.dev/), using the PowerSync Web SDK and a Supabase backend.

diff --git a/packages/powersync-sdk-common/src/db/DBAdapter.ts b/packages/powersync-sdk-common/src/db/DBAdapter.ts
@@ -42,12 +42,14 @@ export interface DBGetUtils {
 }
 
 export interface LockContext extends DBGetUtils {
-  /** Execute a statement and optionally return results. */
+  /** Execute a single write statement. */
   execute: (query: string, params?: any[] | undefined) => Promise<QueryResult>;
 }
 
 export interface Transaction extends LockContext {
+  /** Commit multiple changes to the local DB using the Transaction context. */
   commit: () => Promise<QueryResult>;
+  /** Roll back multiple attempted changes using the Transaction context. */
   rollback: () => Promise<QueryResult>;
 }
 

diff --git a/packages/powersync-sdk-react-native/README.md b/packages/powersync-sdk-react-native/README.md
@@ -6,7 +6,7 @@
 
 [PowerSync](https://powersync.com) is a service and set of SDKs that keeps Postgres databases in sync with on-device SQLite databases. 
 
-This package ([packages/powersync-sdk-react-native](./packages/powersync-sdk-react-native/README.md)) is the PowerSync SDK for React Native clients. It is an extension of `packages/powersync-sdk-common`.
+This package (`packages/powersync-sdk-react-native`) is the PowerSync SDK for React Native clients. It is an extension of `packages/powersync-sdk-common`.
 
 See a summary of features [here](https://docs.powersync.co/client-sdk-references/react-native-and-expo).
 
@@ -90,7 +90,7 @@ Add the Babel plugin to your `babel.config.js` file
 
 # Native Projects
 
-This package uses native libraries. Create native Android and iOS projects (if not created already) with
+This package uses native libraries. Create native Android and iOS projects (if not created already) by running:
 
 ```bash
 npx expo run:android
@@ -106,9 +106,13 @@ Our [SDK reference](https://docs.powersync.com/client-sdk-references/react-nativ
 
 A changelog for this SDK is available [here](https://releases.powersync.com/announcements/react-native-client-sdk).
 
+# API Reference
+
+The full API reference for this SDK can be found [here](https://powersync-ja.github.io/powersync-js/react-native-sdk).
+
 # Examples
 
-For example projects built with PowerSync and React Native, see our [Demo Apps / Example Projects](https://docs.powersync.com/resources/demo-apps-example-projects#react-native-and-expo) gallery.
+For example projects built with PowerSync and React Native, see our [Demo Apps / Example Projects](https://docs.powersync.com/resources/demo-apps-example-projects#react-native-and-expo) gallery. Most of these projects can also be found in the [`demos/`](../demos/) directory.
 
 # Found a bug or need help?
 

diff --git a/packages/powersync-sdk-web/README.md b/packages/powersync-sdk-web/README.md
@@ -6,7 +6,7 @@
 
 [PowerSync](https://powersync.com) is a service and set of SDKs that keeps Postgres databases in sync with on-device SQLite databases. 
 
-This package ([packages/powersync-sdk-web](./packages/powersync-sdk-web/README.md)) is the PowerSync SDK for JavaScript Web clients. It is an extension of `packages/powersync-sdk-common`.
+This package (`packages/powersync-sdk-web`) is the PowerSync SDK for JavaScript Web clients. It is an extension of `packages/powersync-sdk-common`.
 
 See a summary of features [here](https://docs.powersync.com/client-sdk-references/js-web).
 
@@ -40,9 +40,13 @@ Our [full SDK reference](https://docs.powersync.com/client-sdk-references/js-web
 
 A changelog for this SDK is available [here](https://releases.powersync.com/announcements/powersync-js-web-client-sdk).
 
+# API Reference
+
+The full API reference for this SDK can be found [here](https://powersync-ja.github.io/powersync-js/web-sdk).
+
 # Examples
 
-For example projects built with PowerSync on Web, see our [Demo Apps / Example Projects](https://docs.powersync.com/resources/demo-apps-example-projects#js-web) gallery.
+For example projects built with PowerSync on Web, see our [Demo Apps / Example Projects](https://docs.powersync.com/resources/demo-apps-example-projects#js-web) gallery. Most of these projects can also be found in the [`demos/`](../demos/) directory.
 
 # Found a bug or need help?