Readme, clearer

Author: polyclick

README.md

@@ -1,84 +1,98 @@
-# ⚡️ Meta Trader 5 + WebSockets + Real-time Ticker Messages
-An example on how to push real-time ticker updates from MetaTrader 5 over WebSockets to any server.
+# ⚡️ MetaTrader 5 + WebSockets + Real-time Ticker Messages
+
+A solution for streaming real-time ticker updates from MetaTrader 5 over WebSockets to any server.
 
 ![Real-time Tickers](/Readme-assets/Tickers.gif)
 
-- 📘 Uses the robust WebSocket library implementation found in the MQL5 Book
-- ⚡️ Sets a super tight update interval to have near-zero latency ticker updates
-- 🚚 Combines ticker updates for symbols that changed in the same interval
-- 📚 Uses JAson library to serialize/deserialize json
+- 📘 Leverages the robust WebSocket library implementation from the MQL5 Book
+- ⚡️ Implements tight update intervals for near-zero latency ticker updates
+- 🚚 Batches ticker updates for symbols that changed within the same interval
+- 📚 Utilizes JAson library for JSON serialization/deserialization
 
-In use for our trade signaling website: [https://solidsignals.xyz](https://solidsignals.xyz) — Consistent Profitable Trades\
+Currently powering our trade signaling platform: [https://solidsignals.xyz](https://solidsignals.xyz) — Consistent Profitable Trades
 Written in MQL5, by polyclick
 
-# Important
+## Important Note
+
+MetaTrader 5 restricts symbol tracking to those listed in the Market Watch window. When configuring the Expert Advisor, ensure that:
+1. All symbols you want to track are added to the Market Watch
+2. Symbol names in your configuration array match exactly with those in Market Watch
+3. Spelling is correct for all symbol names
 
-MetaTrader 5 limits the symbols we can track. You can only request data from symbols that are listed in the Market Watch window. Keep this in mind when configuring the Expert Advisor. You'll find an array of strings for the symbols you want to track. Make sure you add those symbols in the Market Watch. Make sure the symbol name in the script is spelled correctly.
+## Setup Instructions
 
-# Instructions
-## 1. Download this github project
+### 1. Download this GitHub project
 
 Shouldn't be too hard :)
 
+### 2. Install the MQL5Book library
 
-## 2. Install the MQL5Book library
+Place the `MQL5Book` directory in your MetaTrader 5 include directory:
+```
+/MQL5/Include/MQL5Book
+```
 
-Place the `MQL5Book` directory in the default `/MQL5/Include/` directory, resulting in the full path being: `/MQL5/Include/MQL5Book`
+When installed correctly, your directory structure should look like this:
 
-When installed correctly your file structure should look like this:
+![Include Directory Structure](/Readme-assets/Include.png)
 
-![Include](/Readme-assets/Include.png)
+### 3. Set up your Expert Advisor folder
 
-## 3. Create your custom Expert Advisor folder & Copy files
+1. Create a custom Expert Advisor folder at `/MQL5/Experts/{YOUR_FOLDER_NAME}`
+2. Copy all files from the `Expert/` directory in this repo to your custom folder
 
-Create your own custom Expert Advisor folder under `/MQL5/Experts/{FOLDER_NAME}` \
-Copy everything in this repo from `Expert/` into your custom folder
+![Expert Directory Structure](/Readme-assets/Expert.png)
 
-![Include](/Readme-assets/Expert.png)
+### 4. Compile the Expert Advisor
 
-## 4. Compile
+1. Open MetaEditor
+2. Compile the Expert Advisor
+3. Resolve any include path issues that may arise
 
-Compile & pray 🙏🏼 \
-Fix any include path issues
+### 5. Whitelist WebSocket URL
 
-## 6. Whitelist the WebSocket url in Tools > Options
+In MetaTrader 5:
+1. Navigate to Tools > Options
+2. Add your WebSocket server URL to the allowed URLs list
 
-![Whitelist](/Readme-assets/Whitelist.png)
+![Whitelist Configuration](/Readme-assets/Whitelist.png)
 
-## 7. Attach compiled expert to any chart
+### 6. Attach the Expert Advisor to a chart
 
-Although the Expert Advisor doesn't really use the `onTick()` event, we need to add it to a chart to start its execution.
+Even though the Expert Advisor doesn't primarily use the `onTick()` event, it needs to be attached to a chart to initialize and run.
 
-There are some print statements in the code to help you debug.
+Debug messages are included in the code to assist with troubleshooting.
 
-# Extra
+## Development Tools
 
-## Start A Local, Temporary WebSocket Server
-During development, setting up a temporary WebSocket server helps monitoring the sent Expert Advisor messages. For this, I suggest you use `wscat`:
+### Local WebSocket Server Setup
 
-Starts a temporary WebSocket server on your local machine:
-```
+For development and testing, you can create a temporary WebSocket server:
+
+1. Start a local WebSocket server using `wscat`:
+```bash
 npx wscat -l 8080
 ```
-Then, use `untun` to expose the local server for incoming public traffic using CloudFlare (Free):
-```
+
+2. Expose your local server to the internet using `untun` (CloudFlare-based tunneling):
+```bash
 npx untun@latest tunnel http://localhost:8080
 ```
-![Tunnel](/Readme-assets/Tunnel.png)
 
-Untun will return a public url that routes public traffic to your local machine.
+![Tunnel Configuration](/Readme-assets/Tunnel.png)
 
-- Use the public url in the `Tools > Options` dialog (whitelist)
-- Fill in the public url as an input for the Expert Advisor
-
-If connection fails, try different variations of the same url in both the `Tools > Options` (whitelist dialog) and the EA input parameter (WebSocket address):
+3. Use the public URL provided by `untun` in:
+   - The MetaTrader 5 Tools > Options whitelist
+   - The Expert Advisor input parameters
 
+If connection fails, try these URL variations in both the whitelist and EA parameters:
 - `http://random-url.trycloudflare.com`
 - `https://random-url.trycloudflare.com`
 - `ws://random-url.trycloudflare.com`
 - `wss://random-url.trycloudflare.com`
 
-# Getting help
-- Open an issue
-- Check out our website: Solid Signals — [https://solidsignals.xyz](https://solidsignals.xyz)
-- Join us on Discord: [https://discord.gg/NMVSE5mGkX](https://discord.gg/NMVSE5mGkX)
+## Support
+
+- Open an issue on GitHub
+- Visit our website: [https://solidsignals.xyz](https://solidsignals.xyz)
+- Join our Discord community: [https://discord.gg/NMVSE5mGkX](https://discord.gg/NMVSE5mGkX)