Skip to content

Commit

Permalink
improved markdown files + added markdownlint config
Browse files Browse the repository at this point in the history
  • Loading branch information
xHasKx committed Nov 25, 2023
1 parent aea7aa7 commit e3ae985
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
default: true
single-title: false
line-length: false
4 changes: 3 additions & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@
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
4. receiving self-published message
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}
Expand Down
4 changes: 2 additions & 2 deletions examples/last-will/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ 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
received: PUBLISH{qos=1, retain=false, topic="luamqtt/close", payload="Dear client-1, please close your connection", packet_id=1, type=3, dup=false}
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
Expand Down
2 changes: 1 addition & 1 deletion openwrt/README.md
Original file line number Diff line number Diff line change
@@ -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: <https://openwrt.org/docs/guide-developer/helloworld/start>

But luamqtt is written in pure-lua, so you actually don't have to compile anything, only files should be packed correctly.

Expand Down

0 comments on commit e3ae985

Please sign in to comment.