Skip to content

Commit e5dedc7

Browse files
committed
Readme polish
1 parent 635f18d commit e5dedc7

File tree

3 files changed

+10
-16
lines changed

3 files changed

+10
-16
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,9 @@ Packages are published to [NuGet](https://www.nuget.org/profiles/PowerSync).
2020

2121
Demo applications are located in the [`demos/`](./demos/) directory. Also see our [Demo Apps / Example Projects](https://docs.powersync.com/resources/demo-apps-example-projects) gallery which lists all projects by the backend and client-side framework they use.
2222

23-
### Command-Line
24-
25-
- [demos/CommandLine](./demos/CommandLine/README.md): A CLI to-do list example app using a Node-js backend.
26-
- [demos/WPF](./demos/WPF/README.md): This is a demo WPF application that showcases how to use the [PowerSync SDK](https://www.powersync.com) for data synchronization in a to-do list application using a Node-js backend.
23+
- [demos/CommandLine](./demos/CommandLine/README.md): A CLI-based app demonstrating real-time data sync
24+
- [demos/WPF](./demos/WPF/README.md): A Windows desktop to-do list app real-time data sync
25+
- [demos/MAUITodo](./demos/MAUITodo/README.md): A cross-platform mobile and desktop to-do list app built with .NET MAUI, running on iOS, Android and Windows
2726

2827
# Supported Frameworks
2928

demos/MAUITodo/README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
# .NET MAUI ToDo List Demo App
22

3-
## Quickstart for testing (we currently recommend testing on iOS):
4-
1. You need to have one of our Node.js self-host demos ([Postgres](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs) | [MongoDB](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs-mongodb) | [MySQL](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs-mysql)) running, as it provides the PowerSync server that this demo's SDK connects to.
5-
2. In the root directly run:
6-
1. `dotnet run --project Tools/Setup`
7-
2. `dotnet restore`
8-
3. cd into this directory: `* cd demos/MAUITodo `
9-
4. run `dotnet build -t:Run -f:net8.0-ios`
10-
1. Or specify an iOS simulator identifier e.g.: `dotnet build -t:Run -f:net8.0-ios -p:_DeviceName=:v2:udid=B1CA156A-56FC-4C3C-B35D-4BC349111FDF`
11-
5. Changes made to the backend's source DB (inspect via a tool like `psql`) or to the self-hosted aapp's web UI will be synced to this iOS client (and vice versa)
3+
This demo showcases using the [PowerSync .NET SDK](https://docs.powersync.com/client-sdk-references/dotnet) with .NET MAUI (Android, iOS or Windows).
124

5+
## How to test:
136

14-
## Getting Started
7+
To run this demo, you need to have one of our Node.js self-host demos ([Postgres](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs) | [MongoDB](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs-mongodb) | [MySQL](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs-mysql)) running, as it provides the PowerSync server that this demo's SDK connects to.
8+
9+
Changes made to the backend's source DB or to the self-hosted web UI will be synced to this client (and vice versa).
1510

1611
In the repo root, run the following to download the PowerSync extension:
1712

@@ -55,4 +50,4 @@ dotnet build -t:Run -f:net8.0-android -p:_DeviceName=emulator-5554
5550

5651
```sh
5752
dotnet run -f net8.0-windows10.0.19041.0
58-
```
53+
```

demos/WPF/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

5-
This is a demo WPF application that showcases how to use the [PowerSync SDK](https://www.powersync.com) for data synchronization in a to-do list application. The app leverages PowerSync to sync task lists and items while working seamlessly online and offline.
5+
This is a demo WPF application that showcases how to use the [PowerSync .NET SDK](https://docs.powersync.com/client-sdk-references/dotnet) for data synchronization in a to-do list application. The app leverages PowerSync to sync task lists and items while working seamlessly online and offline.
66

77
To run this demo, you need to have one of our Node.js self-host demos ([Postgres](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs) | [MongoDB](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs-mongodb) | [MySQL](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs-mysql)) running, as it provides the PowerSync server that this CLI's PowerSync SDK connects to.
88

0 commit comments

Comments
 (0)