aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvgeny Zinoviev <me@ch1p.io>2021-05-17 23:18:05 +0300
committerEvgeny Zinoviev <me@ch1p.io>2021-05-17 23:18:05 +0300
commit7b2668a902aaf2fe9b0b7ed5600cedd25ac396d0 (patch)
tree97ab255036ec8e6963491149d3029ff4d47a3d51
parent488c19594a19c0ef34244605e95ec215bc98de3d (diff)
readme: add telnet usage example gif
-rw-r--r--PROTOCOL.md6
-rw-r--r--README.md2
-rw-r--r--inverterd-telnet.gifbin0 -> 2087309 bytes
3 files changed, 6 insertions, 2 deletions
diff --git a/PROTOCOL.md b/PROTOCOL.md
index 44eb97a..626fed3 100644
--- a/PROTOCOL.md
+++ b/PROTOCOL.md
@@ -28,4 +28,8 @@ Sending `EOT` (`0x04`) closes connection.
Each response is represented by one or more lines, each ending with `\r\n`, plus
extra `\r\n` in the end.
-First line is always a status, which may be either `ok` or `err`. \ No newline at end of file
+First line is always a status, which may be either `ok` or `err`.
+
+## Usage example
+
+![inverterd-telnet](inverterd-telnet.gif) \ No newline at end of file
diff --git a/README.md b/README.md
index 0eabb79..ece39cc 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ is planned.
- `inverterctl` is a full-featured command line utility with all P18 commands
supported.
- `inverterd` is a daemon that starts a TCP server and implements simple text-based
- telnet-compatible chat [protocol](PROTOCOL.md). It supports all commands and options
+ [telnet-compatible](inverterd-telnet.gif) chat [protocol](PROTOCOL.md). It supports all commands and options
supported by inverterctl, and it's supposed to be used instead of interterctl in
multi-user or multi-threaded scenarios, where there may be more than one simultaneous
request to device, to avoid errors or device lockups.
diff --git a/inverterd-telnet.gif b/inverterd-telnet.gif
new file mode 100644
index 0000000..dc26a0c
--- /dev/null
+++ b/inverterd-telnet.gif
Binary files differ