update readme

Author: dhoomakethu

README.md

@@ -9,7 +9,7 @@ Pymodbus-REPL is a REPL (Read-Eval-Print Loop) tool for working with Modbus devi
 - Python 3.8+
 - Poetry (installed globally or within a virtual environment)
 
-### Installation
+### Dev instructions
 
 1. Clone the repository:
 
@@ -23,6 +23,80 @@ Pymodbus-REPL is a REPL (Read-Eval-Print Loop) tool for working with Modbus devi
 
     `poetry install`
 
+**NOTE** This repo is meant to be an helper for [pymodbus](https://github.com/pymodbus-dev/pymodbus) and the usage requires
+a working version of pymodbus.
+
+The installed `pymodbus` library for local development can also have impact on the path resolution while working locally on this repo.
+To overcome that problem, please make sure to run the [client](./pymodbus/client/main.py) and [server](./pymodbus/server/main.py) files
+from with in the respective working directories.
+
+For .e.g
+
+#### Run Server
+```
+(pymodbus3.8)
+pymodbus/repl/server on  repl-server-startup [!?] via 🐍 v3.8.13 (pymodbus3.8)
+❯ python3 main.py --host 0.0.0.0 --verbose run --modbus-config default_config.json --modbus-server tcp --modbus-framer socket --modbus-port 5020 --unit-id 1 --unit-id 2 -u 4 -r 1 --timeout 2
+2024-02-17 13:27:17,218 INFO  logging:97 Modbus server started
+2024-02-17 13:27:17,219 DEBUG logging:103 Awaiting connections server_listener
+2024-02-17 13:27:17,219 INFO  logging:97 Server listening.
+
+__________                          .______.                    _________
+\______   \___.__. _____   ____   __| _/\_ |__  __ __  ______  /   _____/ ______________  __ ___________
+ |     ___<   |  |/     \ /  _ \ / __ |  | __ \|  |  \/  ___/  \_____  \_/ __ \_  __ \  \/ // __ \_  __ \\
+ |    |    \___  |  Y Y  (  <_> ) /_/ |  | \_\ \  |  /\___ \   /        \  ___/|  | \/\   /\  ___/|  | \/
+ |____|    / ____|__|_|  /\____/\____ |  |___  /____//____  > /_______  /\___  >__|    \_/  \___  >__|
+           \/          \/            \/      \/           \/          \/     \/                 \/
+
+
+SERVER >
+```
+
+#### Run client
+```
+pymodbus/repl/client on  repl-server-startup [!?] via 🐍 v3.8.13 (pymodbus3.8)
+❯ python3 main.py tcp --port 5020 --framer tcp
+
+----------------------------------------------------------------------------
+__________          _____             .___  __________              .__
+\______   \___.__. /     \   ____   __| _/  \______   \ ____ ______ |  |
+ |     ___<   |  |/  \ /  \ /  _ \ / __ |    |       _// __ \\\____ \|  |
+ |    |    \___  /    Y    (  <_> ) /_/ |    |    |   \  ___/|  |_> >  |__
+ |____|    / ____\____|__  /\____/\____ | /\ |____|_  /\___  >   __/|____/
+           \/            \/            \/ \/        \/     \/|__|
+                                        v1.3.1 - 3.6.4
+----------------------------------------------------------------------------
+
+> client.read_input_registers address 1 count 1 slave 4
+{
+    "registers": [
+        34518
+    ]
+}
+
+> client.read_input_registers address 1 count 1 slave 1
+{
+    "registers": [
+        32198
+    ]
+}
+
+> client.read_input_registers address 1 count 1 slave 2
+{
+    "registers": [
+        51557
+    ]
+}
+
+> client.read_input_registers address 1 count 1 slave 3
+{
+    "original_function_code": "4 (0x4)",
+    "error": "[Input/Output] Modbus Error: [Invalid Message] No response received, expected at least 8 bytes (0 received)"
+}
+
+```
+
+
 ### Running Tests
 To run tests, use the following command: 
 

pymodbus_repl/server/cli.py

@@ -114,8 +114,8 @@ def print_title():
     max_len = max(  # pylint: disable=consider-using-generator
         [len(t) for t in TITLE.split("\n")]
     )
+    title = TITLE.format(repl_version, pymodbus_version)
     if col > max_len:
-        title = TITLE.format(repl_version, pymodbus_version)
         info(title)
     else:
         print_formatted_text(