Skip to content

Commit a193872

Browse files
author
Ravi Singh
committed
docs: rename PWA to TankSync Cloud in README
User-facing branding: TankSync Cloud for the hosted dashboard, folder stays pwa/ as developer convention.
1 parent 54e41df commit a193872

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Long-range wireless water tank level monitoring using LoRa (RYLR998), ESP32, and
3131
| 192.168.x.x
3232
+---------+---------+
3333
| |
34-
Home Assistant TankSync PWA
35-
(auto-discovery) (cloud dashboard)
34+
Home Assistant TankSync Cloud
35+
(auto-discovery) (web dashboard)
3636
```
3737

3838
## Features
@@ -43,7 +43,7 @@ Long-range wireless water tank level monitoring using LoRa (RYLR998), ESP32, and
4343
- **Local Display**: SH1106 1.3" OLED on receiver shows tank levels, battery, signal
4444
- **Web UI**: Built-in configuration interface on the receiver (WiFi, MQTT, LoRa, OTA)
4545
- **Home Assistant**: Native MQTT auto-discovery integration
46-
- **TankSync PWA**: Optional cloud dashboard with push notifications, multi-site, QR linking
46+
- **TankSync Cloud**: Web dashboard with push notifications, multi-site monitoring, QR device linking
4747
- **OTA Updates**: WiFi OTA for receiver, LoRa OTA relay for transmitter
4848
- **Captive Portal**: Auto-redirect WiFi setup on iOS, Android, and Windows
4949
- **Remote Config**: Push sleep interval and sample count to transmitters over LoRa
@@ -110,10 +110,13 @@ idf.py -p /dev/ttyACM0 flash
110110
3. Configure your home WiFi credentials, MQTT broker, and LoRa settings
111111
4. **Transmitter** auto-pairs on first boot -- press the "Start Pairing" button in the receiver web UI
112112

113-
## TankSync PWA (Optional Cloud Dashboard)
113+
## TankSync Cloud
114114

115-
A Progressive Web App for monitoring tanks from anywhere.
115+
A web dashboard for monitoring your tanks from anywhere. Use the hosted version or self-host your own.
116116

117+
**Hosted:** [tanksync.smartghar.org](https://tanksync.smartghar.org) -- scan the QR code from your receiver's web UI to link your device.
118+
119+
**Self-host:**
117120
```bash
118121
cd pwa
119122
npm install
@@ -141,9 +144,9 @@ firmware/
141144
receiver/ ESP32 DevKit receiver (MIT)
142145
receiver-c3/ ESP32-C3 receiver variant (MIT)
143146
transmitter/ ESP32-C3 transmitter (MIT)
144-
pwa/ TankSync cloud dashboard (AGPL-3.0)
147+
pwa/ TankSync Cloud dashboard (AGPL-3.0)
145148
server/ Fastify + SQLite + MQTT bridge
146-
client/ React + Tailwind PWA frontend
149+
client/ React + Tailwind frontend
147150
hardware/ BOM and hardware designs (CC BY-SA 4.0)
148151
docs/ Documentation and images
149152
```

0 commit comments

Comments
 (0)