Skip to content

Commit 6535026

Browse files
committed
Update README.md
1 parent 031b6b4 commit 6535026

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
# MQTTNotifier
2-
Windows 10 background application that creates Toast Notifications from MQTT messages.
2+
Lightweight Windows 10 background application that creates Toast Notifications from MQTT messages.
33

4+
Designed intentionally for simplicity & portability:
5+
- .NET Framework 4.5.2: probably even runs on Windows 8 (not tested)
6+
- No additional runtimes, libraries or dependencies
7+
- Portable: no installation required
8+
9+
![Screenshot of Windows 11 Toast Notification](screenshot.png "Screenshot of Windows 11 Toast Notification")
10+
11+
## Message formats
412
Supports two message formats:
513
- Raw: Message text appears as the content
614
- JSON (HomeAssistant format): `{"title": "Message title", "message": "Hello world!"}`
715

8-
![Screenshot of Windows 11 Toast Notification](screenshot.png "Screenshot of Windows 11 Toast Notification")
9-
1016
# Usage
1117
The program folder can be placed anywhere (e.g. C:\Program Files\MQTTNotifier)
1218

@@ -15,5 +21,12 @@ Add a shortcut to `MQTTNotifier.exe` in your Startup folder (optional)
1521
# Configuration
1622
All configuration is in `MQTTNotifier.exe.config` - which must be located beside the executable itself.
1723

24+
# Building
25+
The build toolchain that comes with Windows works:
26+
```bat
27+
PATH=%PATH%;C:\Windows\Microsoft.NET\Framework\v4.0.30319
28+
msbuild
29+
```
30+
1831
# Credits
1932
Uses the M2MQTT library: https://www.nuget.org/packages/M2Mqtt/

0 commit comments

Comments
 (0)