From: Marwan Yassini <yassinimarwan6@gmail.com>
Date: Tue, 29 Oct 2024 17:22:03 +0000 (+0000)
Subject: mqtt: fix mqtt.md wording and add clearer explanation
X-Git-Tag: curl-8_11_0~27
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=e4aa07b52698b1e51dcaa11e2b005b402faced99;p=thirdparty%2Fcurl.git

mqtt: fix mqtt.md wording and add clearer explanation

Some of the wording in the mqtt.md confused me as to how the commands
were used and what they did, so I cleared up some of the wording to
better explain what each command does.

Closes #15451
---

diff --git a/docs/internals/MQTT.md b/docs/internals/MQTT.md
index a1bc4b349e..58a3585662 100644
--- a/docs/internals/MQTT.md
+++ b/docs/internals/MQTT.md
@@ -9,19 +9,35 @@ SPDX-License-Identifier: curl
 ## Usage
 
 A plain "GET" subscribes to the topic and prints all published messages.
+
 Doing a "POST" publishes the post data to the topic and exits.
 
+
+### Subscribing
+Command usage:
+    
+    curl mqtt://host/topic
+
 Example subscribe:
 
     curl mqtt://host.home/bedroom/temp
 
+This will send an MQTT SUBSCRIBE packet for the topic `bedroom/temp` and listen in for incoming PUBLISH packets.
+
+### Publishing
+Command usage:
+
+    curl -d payload mqtt://host/topic
+
 Example publish:
 
     curl -d 75 mqtt://host.home/bedroom/dimmer
 
+This will send an MQTT PUBLISH packet to the topic `bedroom/dimmer` with the payload `75`.
+
 ## What does curl deliver as a response to a subscribe
 
-It outputs two bytes topic length (MSB | LSB), the topic followed by the
+Whenever a PUBLISH packet is received, curl outputs two bytes topic length (MSB | LSB), the topic followed by the
 payload.
 
 ## Caveats