docs: update README to clarify running a Portal App using Tunnel and SDK
rabbitprincess committed
Dec 5, 2025 at 20:50 UTC
0010ddd5524d4c2c266b615442954c0df1c1406f
1 file changed
+8
-4
README.md
+8
-4
@@ -54,15 +54,19 @@ BOOTSTRAP_URIS: wss://portal.example.com/relay
54
55
```
56
57
-### Running a Portal App
57
+### Running a Portal App using Tunnel
58
59
-1. Start your local service
59
+```bash
60
+# 1. Start your local service
61
61
-2. Run the tunnel client to expose
62
-```sh
62
+# 2. Run the tunnel client to expose
63
curl -fsSL http://localhost:4017/tunnel | PORT=3000 NAME=myapp sh
64
+
65
```
66
67
+### Running a Portal App using the SDK
68
+See [portal-toys](https://github.com/gosuda/portal-toys)
69
+
70
## Architecture
71
72
For a detailed overview of system components and data flow, see the [architecture documentation](docs/architecture.md).