Skip to content

Commit 303aa1d

Browse files
authored
Update README.md
1 parent 375ad45 commit 303aa1d

1 file changed

Lines changed: 61 additions & 2 deletions

File tree

README.md

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,61 @@
1-
# SwitchBot-App
2-
SwitchBot Desktop App and also Web App
1+
# SwitchBot Desktop App
2+
3+
There is currently no official desktop app for SwitchBot, so I’ve created one.
4+
5+
This application uses the **mobile API** (instead of the limited Open API available on GitHub), allowing it to support more features and eventually match the functionality of the official mobile app.
6+
7+
---
8+
9+
## 📸 Screenshots
10+
11+
<img src="./img/1.png" alt="Screenshot 1" width="600"/>
12+
<img src="./img/2.png" alt="Screenshot 2" width="600"/>
13+
<img src="./img/3.png" alt="Screenshot 3" width="600"/>
14+
15+
---
16+
17+
## 💻 Desktop Application
18+
19+
Download the latest installer from the [Releases](../../releases) section.
20+
21+
Supported platforms:
22+
- Windows
23+
- macOS
24+
- Linux
25+
26+
---
27+
28+
## 🌐 Web Application
29+
30+
### Multi-Device Setup
31+
32+
To access the app from multiple devices, set the following environment variable in `/client/.env`:
33+
34+
```env
35+
REACT_APP_SERVER_URL=http://<your-server-ip>:8089
36+
```
37+
38+
Replace `<your-server-ip>` with the actual IP address of the server hosting the backend.
39+
40+
---
41+
42+
## 💬 Discussions
43+
44+
Got questions, suggestions, or just want to chat? Join the discussion:
45+
👉 [Discussion Thread #1](https://github.com/dbghelp/SwitchBot-App/discussions/1)
46+
47+
---
48+
49+
## 🧪 Implementation & Testing
50+
51+
This app is developed and tested using only the SwitchBot devices I personally own.
52+
Support for other devices may vary.
53+
54+
---
55+
56+
## ☕️ Support / Donation
57+
58+
If you find this project helpful, consider donating to support its development.
59+
Your contribution is greatly appreciated!
60+
61+
---

0 commit comments

Comments
 (0)