Merge branch 'main' into feat/token-message-rich

README.md

@@ -1 +1,31 @@
-# crypto price bot
+# crypto price bot
+
+Telegram bot tra giá crypto (Spot / Future / Alpha), funding rate và margin APR.
+
+## Environment variables
+
+Tạo file `.env` ở root project với các biến sau:
+
+```env
+# BẮT BUỘC: token bot Telegram
+TELEGRAM_TOKEN=your_telegram_bot_token
+
+# TÙY CHỌN: bật/tắt log env mode (mặc định true nếu không set)
+# giá trị hợp lệ: true / false
+LOG_ENV=true
+
+# TÙY CHỌN nhưng KHUYẾN NGHỊ: Telegram user id được phép dùng /refresh
+# nếu không set hoặc set sai format -> /refresh sẽ bị từ chối cho tất cả user
+ADMIN_CHAT_ID=123456789
+```
+
+## Run
+
+```bash
+go run ./cmd/tele
+```
+
+## Notes
+
+- `TELEGRAM_TOKEN` sai/thiếu: bot sẽ fail khi khởi tạo Telegram service.
+- `/refresh` dùng để refresh trading pair cache thủ công và chỉ cho `ADMIN_CHAT_ID`.