@powersync/react-native 1.8.4 → 1.10.0

package/README.md

@@ -4,9 +4,9 @@
 
 # PowerSync SDK for React Native
 
-*[PowerSync](https://www.powersync.com) is a Postgres-SQLite sync layer, which helps developers to create local-first real-time reactive apps that work seamlessly both online and offline.*
+_[PowerSync](https://www.powersync.com) is a Postgres-SQLite sync layer, which helps developers to create local-first real-time reactive apps that work seamlessly both online and offline._
 
-This package (`packages/react-native`) is the PowerSync SDK for React Native clients. It is an extension of `packages/common`.
+This package (`packages/react-native`) is the PowerSync SDK for React Native clients. It is an extension of `packages/common`. It connects to a PowerSync instance via HTTP streams (enabled by default) or WebSockets.
 
 See a summary of features [here](https://docs.powersync.co/client-sdk-references/react-native-and-expo).
 
@@ -30,68 +30,7 @@ npx expo install @journeyapps/react-native-quick-sqlite
 
 ## Install Polyfills
 
-This package connects to a PowerSync instance via HTTP streams (enabled by default) or WebSockets. 
-* Both connection methods require the [React Native Common Polyfills](#react-native-common-polyfills), as detailed below. 
-* The WebSocket method requires an [additional polyfill](#web-sockets-buffer) for the `Buffer` interface.
-* Other polyfills are required for [watched queries](#babel-plugins-watched-queries) using the Async Iterator response format.
-
-### React Native Common Polyfills
-
-This package requires polyfills for HTTP streaming and other text encoding functions. These functions can be provided with [react-native-polyfill-globals](https://www.npmjs.com/package/react-native-polyfill-globals).
-
-Install the collection of polyfills with:
-
-```bash
-npx expo install react-native-polyfill-globals
-```
-
-The `react-native-polyfill-globals` package uses peer dependencies for individual functions. Most modern package managers install peer dependencies by default, however currently the peer dependency version ranges are quite broad and might result in certain packages being incompatible. Currently an [issue](https://github.com/acostalima/react-native-polyfill-globals/issues/6) is open for a breaking change in one of the dependencies. The best practice is to currently add the packages as explicit dependencies with version ranges to your project with the command below.
-
-```bash
-npx expo install react-native-fetch-api@^3.0.0 react-native-url-polyfill@^2.0.0 text-encoding@^0.7.0 web-streams-polyfill@3.2.1 base-64@^1.0.0
-```
-
-Enable the polyfills in React Native app by adding the following in your top level entry point
-
-```JavaScript
-// App.js
-import 'react-native-polyfill-globals/auto';
-```
-
-### HTTP Connections
-
-HTTP connections require the HTTP streaming polyfills included in the [common section](#react-native-common-polyfills). See additional [setup](https://docs.powersync.com/client-sdk-references/react-native-and-expo#android-flipper-network-plugin) required for Android.
-
-### WebSocket Connections: Buffer
-
-Note: Beta Release - WebSockets are currently in a beta release. It should be safe to use in production if sufficient testing is done on the client side.
-
-Our WebSocket implementation supports binary payloads which are encoded as BSON documents.
-
-This requires support for the `Buffer` interface.
-
-Apply the `Buffer` polyfill
-
-```bash
-npx expo install @craftzdog/react-native-buffer
-```
-
-```javascript
-import { Buffer } from '@craftzdog/react-native-buffer';
-
-if (typeof global.Buffer == 'undefined') {
-  // @ts-ignore If using TypeScript
-  global.Buffer = Buffer;
-}
-```
-
-This library uses `RSocket` for reactive WebSocket streams which requires `process.nextTick` to be available. Apply a polyfill if not available.
-
-```javascript
-if (typeof process.nextTick == 'undefined') {
-  process.nextTick = setImmediate;
-}
-```
+- Polyfills are required for [watched queries](#babel-plugins-watched-queries) using the Async Iterator response format.
 
 ### Babel Plugins: Watched Queries