Updated readme

dexie · Dec 6, 2024 · e3e7acb · e3e7acb
1 parent 9cb9896
commit e3e7acb
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/addons/dexie-cloud/README.md b/addons/dexie-cloud/README.md
@@ -1,14 +1,34 @@
 The web client for [Dexie Cloud](https://dexie.org/cloud/).
 
-# Getting started
+## Getting started
+
+```
+npm install dexie-cloud-addon
+```
+
+```ts
+import dexieCloud from 'dexie-cloud-addon';
+
+const db = new Dexie('dbname', { addons: [dexieCloud]});
+
+db.version(1).stores({
+    yourTable: '@primKeyProp, indexedProp1, indexedProp2, ...'
+});
+
+db.cloud.configure({
+  databaseUrl: 'https://<yourdb>.dexie.cloud'
+})
+```
+
+## Obtaining a database URL
 
 Run the following command in a console / terminal:
 
 ```
 npx dexie-cloud create
 ```
 
-...then follow the instructions on https://dexie.org/cloud/#getting-started
+See also https://dexie.org/cloud/#getting-started
 
 *Having problems getting started, please [file an issue](https://github.com/dexie/Dexie.js/issues/new)*
 

diff --git a/addons/dexie-cloud/package.json b/addons/dexie-cloud/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dexie-cloud-addon",
-  "version": "4.1.0-beta.36",
+  "version": "4.1.0-beta.37",
   "description": "Dexie addon that syncs with to Dexie Cloud",
   "main": "dist/umd/dexie-cloud-addon.js",
   "type": "module",