summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2023-03-27 17:33:05 +0200
committerxengineering <me@xengineering.eu>2023-03-27 17:33:05 +0200
commit5d1d9e09e3fd26228230bb325ca3d5ddf2576070 (patch)
treeb71d36738059411a6b4f1a07d2f4bde45a2c7b9d
parent99298a40a29473940e3b1b96940187d6b34cf55c (diff)
downloadwebiot-5d1d9e09e3fd26228230bb325ca3d5ddf2576070.tar
webiot-5d1d9e09e3fd26228230bb325ca3d5ddf2576070.tar.zst
webiot-5d1d9e09e3fd26228230bb325ca3d5ddf2576070.zip
Reformat README from plaintext to Markdown
Syntax highlighting is a nice thing and READMEs could be rendered in the future via a CI-like build automation system.
-rw-r--r--README.md (renamed from README.txt)12
1 files changed, 4 insertions, 8 deletions
diff --git a/README.txt b/README.md
index a78de7c..c9b7181 100644
--- a/README.txt
+++ b/README.md
@@ -1,8 +1,6 @@
-------
-webiot
-------
+# webiot
A small webserver for my personal Internet of Things (IoT). This software is
tailor-made for my personal need supporting only the devices I actually use.
@@ -10,16 +8,14 @@ Nevertheless it could be interesting for you if you want to use my code for
your project.
-Supported IoT devices
----------------------
+## Supported IoT devices
Currently only this device is supported:
- tp-link HS100 WiFi plug [1]
-Architecture
-------------
+## Architecture
There are three device categories relevant for the architecture:
@@ -32,4 +28,4 @@ device via its native protocol (TCP, HTTP, MQTT, etc.). The user interaction is
done only via the web interface.
-[1] https://www.tp-link.com/en/home-networking/smart-plug/hs100/
+[1]: https://www.tp-link.com/en/home-networking/smart-plug/hs100/