Skip to content

Commit

Permalink
Update runtime support in README
Browse files Browse the repository at this point in the history
  • Loading branch information
notrab committed Feb 19, 2024
1 parent 2b4f114 commit 3722f19
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ npm install @libsql/client

## Import

This library supports multiple runtimes, including Node.js, Cloudflare Workers, and Deno.
This library supports multiple runtimes, including Node.js, Cloudflare Workers, Deno, and experimental WebAssembly.

**Make sure you import the correct client for your environment:**

Expand All @@ -44,6 +44,7 @@ This library supports multiple runtimes, including Node.js, Cloudflare Workers,
| Browsers | `import { createClient } from "@libsql/client/web"` |
| Edge <br />(Cloudflare/Vercel) | `import { createClient } from "@libsql/client/web"` |
| Deno | `import { createClient } from "https://esm.sh/@libsql/client@[version]/web"` |
| WebAssembly (Experimental) | `import { createClient } from "@libsql/client-wasm"` |

## Connect

Expand Down Expand Up @@ -88,7 +89,7 @@ const client = createClient({
});
```

Embedded Replicas aren'require access to the filesystem, serverless environments aren't compatible.
Embedded Replicas require access to the filesystem, **serverless environments aren't compatible**.

### libSQL Server

Expand Down Expand Up @@ -130,7 +131,7 @@ const result = await client.execute({

### Sync

If you're using [Embedded Replicas](#embedded-replicas), you should call `sync()` in the background whenever your application wants to sync the remote and local embedded replica. For example, you can call it every 5 minutes or every time the application starts.
If you're using [Embedded Replicas](#embedded-replicas), you should call `sync()` in the background whenever your application wants to sync local embedded replica with the remote database. For example, you can call it every 5 minutes or every time the application starts.

```ts
import { createClient } from "@libsql/client";
Expand Down

0 comments on commit 3722f19

Please sign in to comment.