docs: Update README.md with badges and SocketIO integration examples

Author: Msameim181

Diff for: README.md

@@ -1,4 +1,17 @@
 # Chromatrace
+---
+[![GitHub](https://img.shields.io/github/license/Msameim181/Python-Logging-Best-Practice.svg)]()
+[![Version](https://badge.fury.io/gh/Msameim181%2FPython-Logging-Best-Practice.svg)](https://badge.fury.io/gh/Msameim181%2FPython-Logging-Best-Practice)
+[![GitHub Release](https://img.shields.io/github/release/Msameim181/Python-Logging-Best-Practice.svg?style=flat)]()  
+[![GitHub Release Date](https://img.shields.io/github/release-date/Msameim181/Python-Logging-Best-Practice.svg?style=flat)]()
+[![GitHub Release Date](https://img.shields.io/github/last-commit/Msameim181/Python-Logging-Best-Practice.svg?style=flat)]()  
+[![GitHub issues](https://img.shields.io/github/issues/Msameim181/Python-Logging-Best-Practice.svg)]()
+
+[![PyPi Version](https://img.shields.io/pypi/v/chromatrace.svg)](https://pypi.python.org/pypi/chromatrace/)
+[![PyPi Version Alt](https://badge.fury.io/py/chromatrace.svg)](https://pypi.python.org/pypi/chromatrace/)  
+![PyPI Downloads](https://static.pepy.tech/badge/chromatrace)
+[![Python Versions](https://img.shields.io/pypi/pyversions/chromatrace.svg)]()
+
 
 Chromatrace is a Python package designed for advanced logging capabilities, including trace and request ID management. It provides a flexible logging configuration and supports colored logging for better visibility.
 
@@ -153,9 +166,38 @@ Something went wrong in second service
 As you can see, the request ID - `R-ffe0a9a2` is automatically added to the log messages from the thread that handles the request.
 
 
+### SocketIO Integration
+
+```python
+from chromatrace import SocketRequestIdMiddleware
+
+socket_application = SocketRequestIdMiddleware(socket_application)
+```
+The full example can be found in the [socket_app.py](src/examples/socket_app.py) file. I recommend you to check it out before making any decision. The client-side code can be found in the [socket_client.py](src/examples/socket_client.py) file.
+
+Result:
+```log
+[S-4e2b7c5e]-[Development]-(2024-12-06 01:15:18)-[INFO]-[Socket]-FILENAME:socket_app.py-FUNC:connect-THREAD:MainThread-LINE:86 :: 
+Socket connected on main namespace. SID: wB-srwnv9Xa2w_8bAAAB
+
+[S-4e2b7c5e]-[Development]-(2024-12-06 01:15:20)-[INFO]-[Socket]-FILENAME:socket_app.py-FUNC:message-THREAD:MainThread-LINE:90 :: 
+Received message on main namespace. SID: wB-srwnv9Xa2w_8bAAAB, Message: Hello from the client
+
+[S-aaf46528]-[Development]-(2024-12-06 01:15:47)-[INFO]-[Socket]-FILENAME:socket_app.py-FUNC:connect-THREAD:MainThread-LINE:86 :: 
+Socket connected on main namespace. SID: FI3E_S_A-KsTi4RLAAAD
+
+[S-aaf46528]-[Development]-(2024-12-06 01:15:49)-[INFO]-[Socket]-FILENAME:socket_app.py-FUNC:message-THREAD:MainThread-LINE:90 :: 
+Received message on main namespace. SID: FI3E_S_A-KsTi4RLAAAD, Message: Hello from the client
+```
+
+Yes, the socket logs are also within the trace. The trace ID - `S-4e2b7c5e` and `S-aaf46528` was added to the log messages. For better experience, the prefix `S` was added to the trace ID to differentiate it from the request ID.
+
+
 ## Examples
 
-You can find examples of how to use Chromatrace in the [examples](src/exmples/) directory. Run the examples using the following command:
+> You don't trust me, do you? I understand. You wanna see it in action, right? I got you covered. :)
+
+You can find examples of how to use Chromatrace in the [examples](src/examples/) directory. Run the examples using the following command:
 
 ```bash
 python main.py
@@ -167,7 +209,16 @@ Then, run:
 curl 0.0.0.0:8000
 ```
 
-Now, check the logs in the terminal. :)
+Now, check the logs in the terminal.
+
+Also, the socket server will start and wait for the client to connect on `http://localhost:8001`.
+For socket client-side run the following command in another terminal:
+
+```bash
+python socket_client.py
+```
+
+Now, check the logs in the both terminal.
 
 ## License