Update README: add start.sh, fix Quick Start

- Add start.sh to Quick Start section and project file tree
- Remove broken cp .env.example reference (no such file)
- Annotate .env with config categories
This commit is contained in:
jackyu66git
2026-05-03 20:31:19 +08:00
parent 35d9f7661b
commit de6463530d
+9 -2
View File
@@ -64,10 +64,16 @@ PriceStore ─────────┼─────────────
```bash ```bash
cd exchange-monitor-go cd exchange-monitor-go
go build -o exchange-monitor . go build -o exchange-monitor .
cp .env.example .env # edit to configure # Edit .env to configure (token, threshold, etc.)
./exchange-monitor ./exchange-monitor
``` ```
Or use the startup script (auto-compiles if sources changed, cleans stale port):
```bash
./start.sh
```
Then open [http://localhost:8888](http://localhost:8888) for the Web dashboard. Then open [http://localhost:8888](http://localhost:8888) for the Web dashboard.
## Configuration (.env) ## Configuration (.env)
@@ -174,7 +180,8 @@ exchange-monitor-go/
├── dashboard.go # Web server + SSE + history buffers ├── dashboard.go # Web server + SSE + history buffers
├── toaster.go # Telegram notifications ├── toaster.go # Telegram notifications
├── static.go # Embedded web static files ├── static.go # Embedded web static files
├── .env # Local configuration ├── start.sh # Startup script (port check + build + run)
├── .env # Local configuration (TELEGRAM, API keys, thresholds)
├── exchange/ ├── exchange/
│ ├── connector.go # Generic WS connector with reconnect │ ├── connector.go # Generic WS connector with reconnect
│ ├── binance.go # Binance bookTicker WS │ ├── binance.go # Binance bookTicker WS