Update README.md to enhance project documentation, including an overview of features, technology stack, development setup, deployment instructions, and architecture details for the Pyright WebSocket bridge.

Author: MakanShabani

README.md

@@ -1,6 +1,45 @@
 # Pyright LSP WebSocket Bridge
 
-WebSocket bridge for Pyright language server with bundled Node.js runtime.
+A WebSocket bridge for the Pyright language server with a bundled Node.js runtime. This service provides Python language server capabilities (autocomplete, type checking, diagnostics, etc.) through a WebSocket interface, primarily used by the Jesse dashboard to provide IntelliSense features for Jesse strategies.
+
+## Overview
+
+This repository delivers:
+- **WebSocket Bridge** - Translates WebSocket messages to Pyright LSP protocol
+- **Bundled Runtime** - Includes Node.js, eliminating system dependencies
+- **Cross-Platform Support** - Works on Linux, macOS, and Windows
+- **Optimized Builds** - ~70% size reduction with production-only dependencies
+
+## Technology Stack
+
+- **TypeScript** - Main language for the bridge implementation
+- **Node.js** - Runtime environment
+- **Pyright** - Microsoft's static type checker for Python
+- **WebSocket (ws)** - WebSocket communication
+- **vscode-ws-jsonrpc** - JSON-RPC over WebSocket
+- **esbuild** - Fast JavaScript bundler
+
+## Development
+
+### Setup
+```bash
+npm install
+```
+
+### Running in Development Mode
+```bash
+npm start -- \
+  --port 9011 \
+  --project-root /path/to/project \
+  --jesse-relative-path jesse_folder_name \
+  --bot-relative-path jesse-bot_folder_name
+```
+
+### Command-Line Arguments
+- `--port` - WebSocket server port (default: 9011)
+- `--project-root` - Root directory of the Python project
+- `--jesse-relative-path` - Relative path to Jesse framework folder
+- `--bot-relative-path` - Relative path to Jesse bot folder
 
 ## Build
 
@@ -19,14 +58,14 @@ Outputs:
 - `darwin-x64.tar.gz` / `darwin-arm64.tar.gz`
 - `win32-x64.zip`
 
-## Deploy & Run
+## Deployment & Usage
 
 ### Linux/macOS
 ```bash
-# Extract
+# Extract the archive
 tar -xzf linux-x64.tar.gz
 
-# Run
+# Run the server
 cd linux-x64
 ./start.sh \
   --port 9011 \
@@ -37,22 +76,46 @@ cd linux-x64
 
 ### Windows
 ```cmd
-REM Extract linux-x64.zip, then:
-cd linux-x64
-start.bat --port 9011 --project-root C:\path\to\project --jesse-relative-path jesse_folder_name  --bot-relative-path jesse-bot_folder_nam
+REM Extract win32-x64.zip
+
+REM Run the server
+cd win32-x64
+start.bat --port 9011 --project-root C:\path\to\project --jesse-relative-path jesse_folder_name --bot-relative-path jesse-bot_folder_name
 ```
 
+## Configuration
+
+The Pyright language server is configured via `pyrightconfig.json` in the project root. You can customize type checking behavior, Python version, include/exclude patterns, and more.
+
 ## Features
 
 - ✅ Bundled Node.js runtime (no system dependencies)
 - ✅ Optimized build (~70% size reduction)
 - ✅ Cross-platform support (Linux, macOS, Windows)
 - ✅ Production-ready dependencies only
+- ✅ WebSocket-based communication
+- ✅ Full Pyright LSP capabilities
 
-## Development
+## Architecture
+
+The bridge acts as a middleware between WebSocket clients (like the Jesse dashboard) and the Pyright language server:
 
-```bash
-npm install
-npm start -- --port 9011 --project-root /path/to/project ...
 ```
+Client (Jesse Dashboard) <-> WebSocket <-> Bridge <-> Pyright LSP
+```
+
+Messages are translated between WebSocket and the Language Server Protocol, enabling Python IntelliSense features in web-based interfaces.
+
+## File Structure
+
+- `index.ts` - Entry point and CLI argument handling
+- `pyright-bridge.ts` - WebSocket bridge implementation
+- `pyrightconfig.json` - Pyright configuration
+- `package.json` - Node.js project configuration
+- `build.sh` - Build script for Linux x64
+- `build-all.sh` - Build script for all platforms
+- `output/` - Build output directory (generated)
+
+## License
 
+This project is part of the Jesse ecosystem.