From bbdaa096de1b3134f82ef43f6a30348076ad63aa Mon Sep 17 00:00:00 2001
From: Mahesh MS <72661846+memoryInject@users.noreply.github.com>
Date: Wed, 23 Mar 2022 16:41:14 +0800
Subject: [PATCH] Update README.md

---
 README.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 89 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 00abacf..6426e76 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,89 @@
-# ws-client
-WebSocket client for command line testing WebSocket server
+
+# WS Client
+
+WebSocket command line client for testing WebSocket server.  
+This command line tools based on https://github.com/dhbaird/easywsclient,   
+JSON Parsing using https://github.com/nlohmann/json,   
+Console color and formatting using https://github.com/memoryInject/color-console.  
+
+#### **This application still in an early development phase, only tested with Linux. (It might works on macOS)
+## Screenshots
+
+![App Screenshot](https://res.cloudinary.com/memoryinject/image/upload/h_458,c_scale/v1648024478/ws-client-01_lldds8.png)
+
+![App Screenshot](https://res.cloudinary.com/memoryinject/image/upload/h_258,c_scale/v1648024485/ws-client-02_sl3b32.png)
+
+
+
+## Features
+
+- JSON formatted output to console.
+- Auto reconnect, wait for 5 seconds.
+- Keywords for manual reconnect (`r`, `reset`, `reconnect`, `restart`).
+- Keywords for exit/closing connection (`q`, `quit`, `exit`).
+- Keywords for help (`h`, `help`).
+- Light weight 🍂
+- Blazing fast ⚡
+- Portable 💼
+
+## Build
+
+To build the executable download this repo first, then use `make` to create the executable.
+
+```bash
+git clone https://github.com/memoryInject/ws-client
+cd ws-client
+make
+```
+
+After running the code above it will create executable at `bin/ws`
+
+#### Optional:
+If you want to move the `ws` executable to `~/bin`, run `make move` after running `make`, 
+this will make `ws` added to `path`. 
+## Usage/Examples
+Make sure you build the `ws` executable and added to system `path`.   
+To connect to a WebSocket server pass the WebSocket address as first argument.
+
+```bash
+❯ ws 'ws://localhost:8000/ws'
+Connected: ws://localhost:8000/ws
+
+>>> JSON Data:
+{
+    "message": "connected"
+}
+
+>>> JSON Data:
+{
+    "message": "Hello World!",
+    "type": "notification"
+}
+```
+
+To exit the program type `q` and `enter`
+```bash
+~
+❯ ws 'ws://localhost:8000/ws'
+Connected: ws://localhost:8000/ws
+
+>>> JSON Data:
+{
+    "message": "connected"
+}
+
+>>> JSON Data:
+{
+    "message": "Hello World!",
+    "type": "notification"
+}
+q
+Exit
+~
+❯ 
+```
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+