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 556978f commit 26d1952
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
19 changes: 11 additions & 8 deletions addons/dexie-cloud/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
# Dexie Cloud addon

This library is an addon for Dexie.js that works as the sync client for Dexie Cloud. See https://dexie.org/cloud/
The web client for [Dexie Cloud](https://dexie.org/cloud/).

# Getting started

To start using Dexie Cloud, create a database in the cloud
Run the following command in a console / terminal:

```
npx dexie-cloud create
```

Then follow the instructions on https://dexie.org/cloud/#getting-started
...then follow the instructions on https://dexie.org/cloud/#getting-started

*Having problems getting started, please [file an issue](https://github.com/dexie/Dexie.js/issues/new)*

## The Cloud Service
# The Cloud Service

[![Better Stack Badge](https://uptime.betterstack.com/status-badges/v2/monitor/jist.svg)](https://uptime.betterstack.com/?utm_source=status_badge)

The official production service for Dexie Cloud Server is forever free of charge so you do not need to install any server to get started. The free service has some limits, see https://dexie.org/cloud/pricing

## On-Prem version
# On-Prem version

Dexie Cloud Server is a closed source software that can be purchased and installed on own hardware, see [On-Prem Silver / On-Prem Gold](https://dexie.org/cloud/pricing)

## Dexie Cloud CLI
# CLI

See https://dexie.org/cloud/docs/cli

# APIs

See https://dexie.org/cloud/docs/dexie-cloud-api
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.34",
"version": "4.1.0-beta.35",
"description": "Dexie addon that syncs with to Dexie Cloud",
"main": "dist/umd/dexie-cloud-addon.js",
"type": "module",
Expand Down

0 comments on commit 26d1952

Please sign in to comment.