Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
David Fahlander committed Dec 6, 2024
1 parent e3e7acb commit 301d1ca
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 7 additions & 1 deletion addons/dexie-cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ The web client for [Dexie Cloud](https://dexie.org/cloud/).
## Getting started

```
npm install dexie-cloud-addon
npm install dexie@latest
npm install dexie-cloud-addon@latest
```

```ts
import Dexie from 'dexie';
import dexieCloud from 'dexie-cloud-addon';

const db = new Dexie('dbname', { addons: [dexieCloud]});
Expand All @@ -20,6 +22,10 @@ db.cloud.configure({
})
```

## See also

https://dexie.org/cloud/docs/dexie-cloud-addon#api

## Obtaining a database URL

Run the following command in a console / terminal:
Expand Down
2 changes: 1 addition & 1 deletion addons/dexie-cloud/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dexie-cloud-addon",
"version": "4.1.0-beta.37",
"version": "4.1.0-beta.38",
"description": "Dexie addon that syncs with to Dexie Cloud",
"main": "dist/umd/dexie-cloud-addon.js",
"type": "module",
Expand Down

0 comments on commit 301d1ca

Please sign in to comment.