Skip to content

Commit 98839dd

Browse files
committed
feat: update docs
1 parent b742a8c commit 98839dd

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,37 @@ The application supports two types of MQTT connections:
6060

6161
The connection type can be configured in the application settings.
6262

63+
## Desktop Application
64+
65+
VDA5050 Visualizer is also available as a desktop application built with Electron. The desktop version provides all the features of the web application plus native desktop integration.
66+
67+
### Running the Desktop App in Development
68+
69+
To run the desktop application in development mode:
70+
71+
```bash
72+
npm run electron:dev
73+
```
74+
75+
This will start both the Vite development server and the Electron application.
76+
77+
### Building the Desktop App
78+
79+
To build the desktop application for distribution:
80+
81+
```bash
82+
npm run electron:build
83+
```
84+
85+
This will create platform-specific installers in the `dist_electron` directory. The application is configured to build for:
86+
- Windows (.exe installer)
87+
- macOS (.dmg)
88+
- Linux (AppImage)
89+
90+
### Auto Updates
91+
92+
The desktop application supports automatic updates through GitHub releases. When a new version is published, the application will automatically detect and prompt users to install the update.
93+
6394
## Development
6495

6596
### Prerequisites
@@ -94,7 +125,9 @@ The purpose of this package is to view and visualize vda5050 messages more quick
94125

95126
https://github.com/bekirbostanci/vda5050_visualizer/assets/26343575/06f22e56-1547-451b-97b9-870a715d525e
96127

97-
![alt text](docs/1.png)
128+
![Web Interface](docs/1.png)
129+
130+
![Desktop Interface](docs/2.png)
98131

99132
- Display all robots on the one graph
100133
- Displaying the real-time position of multiple robots

docs/2.png

938 KB
Loading

0 commit comments

Comments
 (0)