From e3ae985883c1f5c187d4aa4676cde73ca36c4802 Mon Sep 17 00:00:00 2001 From: Alexander Kiranov Date: Sat, 25 Nov 2023 11:51:18 +0200 Subject: [PATCH] improved markdown files + added markdownlint config --- .markdownlint.yaml | 3 +++ examples/README.md | 4 +++- examples/last-will/README.md | 4 ++-- openwrt/README.md | 2 +- 4 files changed, 9 insertions(+), 4 deletions(-) create mode 100644 .markdownlint.yaml diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..d95827a --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,3 @@ +default: true +single-title: false +line-length: false diff --git a/examples/README.md b/examples/README.md index 4a2b5b5..e464dce 100644 --- a/examples/README.md +++ b/examples/README.md @@ -3,6 +3,7 @@ The simplest example are in `examples/simple.lua` file. It's performing all basic MQTT actions: + 1. connecting to broker 2. subscribing to topic 3. publishing message after subscription creation @@ -10,7 +11,8 @@ It's performing all basic MQTT actions: 5. disconnecting from MQTT broker Here is an expected output of such script: -``` + +```console created MQTT client mqtt.client{id="luamqtt-v2-0-0-5807dc7"} running ioloop for it connected: CONNACK{rc=0, sp=false, type=2} diff --git a/examples/last-will/README.md b/examples/last-will/README.md index 2b909eb..fcfd6d0 100644 --- a/examples/last-will/README.md +++ b/examples/last-will/README.md @@ -15,7 +15,7 @@ To reproduce you have to start `client-1.lua` and then `client-2.lua`. Here is an example output of both scripts: -``` +```console $ lua examples/last-will/client-1.lua connected: CONNACK{rc=0, type=2, sp=false} subscribed to luamqtt/close, waiting for connection close command from client-2 @@ -23,7 +23,7 @@ received: PUBLISH{qos=1, retain=false, topic="luamqtt/close", payload="Dea closing connection without DISCONNECT and stopping client-1 ``` -``` +```console $ lua examples/last-will/client-2.lua connected: CONNACK{rc=0, sp=false, type=2} subscribed to luamqtt/lost diff --git a/openwrt/README.md b/openwrt/README.md index 21a41b6..0e1f488 100644 --- a/openwrt/README.md +++ b/openwrt/README.md @@ -1,6 +1,6 @@ # Building a package for OpenWRT -You may build a package with luamqtt library in a standard way, like described here: https://openwrt.org/docs/guide-developer/helloworld/start +You may build a package with luamqtt library in a standard way, like described here: But luamqtt is written in pure-lua, so you actually don't have to compile anything, only files should be packed correctly.