From 1475d2f9aff609e449f67e51629d544902444203 Mon Sep 17 00:00:00 2001 From: Daniel Date: Sun, 23 Feb 2025 23:31:45 +0100 Subject: [PATCH 1/6] docs: update readme documentation --- README.md | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6a205ca..5f864ee 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,38 @@ -# socket_probe +# Socket Probe -A flutter application for testing websocket connections. +`Socket Probe` is a flutter application for testing websocket connections. + +## Features + +- Support websocket WSS and WS Protocols. +- Support Event based sockets like Socket IO. +- Websocket headers and parameters for "event based" websockets. +- 💻 Supports MacOS and Windows. + +-- + +# Installation + +1. You can download the Macos/Windows link directly from github_releases + (https://github.com/TheCodeDaniel/socket_probe/releases) + +or + +2. Create a fork of the repository and run the code. + +### NOTE: On windows, it may display an `unknown publisher error`, you can press on skip or continue + +# Upcoming features (Contributions are very welcome 🙏) + +1. Linux Support. +2. Dark mode support. +3. Shorebird support. +4. Websocket connection history. +5. Websocket speed metrics and custom logs. +6. modern UI re-design. # Contribution instructions. -Always use `dart format --line-length 120 .` to make the code easier to read. +Run the following commands: +`dart format --line-length 120 .` to make the code easier to read. +`flutter analyze` to analyze the code patterns From 872f61deb3fe8cd3e57d406259363ea304ae9ff0 Mon Sep 17 00:00:00 2001 From: "Daniel A." <130862856+TheCodeDaniel@users.noreply.github.com> Date: Sun, 23 Feb 2025 23:33:48 +0100 Subject: [PATCH 2/6] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 5f864ee..30aa424 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ - Websocket headers and parameters for "event based" websockets. - 💻 Supports MacOS and Windows. +# Examples +Example image description + + -- # Installation From 697b4185dc3020ecb2352bbf5087144932a3bf4c Mon Sep 17 00:00:00 2001 From: "Daniel A." <130862856+TheCodeDaniel@users.noreply.github.com> Date: Sun, 23 Feb 2025 23:41:24 +0100 Subject: [PATCH 3/6] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 30aa424..a9bf424 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ # Examples Example image description +![Screen Recording 2025-02-23 at 23 35 46](https://github.com/user-attachments/assets/680cb071-132e-449e-a1a8-8da06a9cb1d9) -- From 3db7ab5580a21713c1d33cd3f1b9733a92d43a24 Mon Sep 17 00:00:00 2001 From: "Daniel A." <130862856+TheCodeDaniel@users.noreply.github.com> Date: Sun, 23 Feb 2025 23:42:03 +0100 Subject: [PATCH 4/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a9bf424..b75f12d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ - 💻 Supports MacOS and Windows. # Examples -Example image description +Example image description
![Screen Recording 2025-02-23 at 23 35 46](https://github.com/user-attachments/assets/680cb071-132e-449e-a1a8-8da06a9cb1d9) From 39316412a749f2d50c708360fc8b10971672c5da Mon Sep 17 00:00:00 2001 From: Daniel Date: Mon, 24 Feb 2025 08:45:41 +0100 Subject: [PATCH 5/6] docs: update readme with video demo --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b75f12d..4a03c57 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,14 @@ - 💻 Supports MacOS and Windows. # Examples + Example image description
-![Screen Recording 2025-02-23 at 23 35 46](https://github.com/user-attachments/assets/680cb071-132e-449e-a1a8-8da06a9cb1d9) +Video Demo :- + -- From 1429895b467efe2933239349b0fd12519d1802e1 Mon Sep 17 00:00:00 2001 From: Daniel Date: Mon, 24 Feb 2025 08:47:02 +0100 Subject: [PATCH 6/6] docs: use gif in-place of readme for screen recording demo --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index 4a03c57..f3bb735 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,7 @@ # Examples Example image description
- -Video Demo :- - +![Screen Recording 2025-02-23 at 23 35 46](https://github.com/user-attachments/assets/680cb071-132e-449e-a1a8-8da06a9cb1d9) --