From 194a235065074da246da9b7d45d85ebddadde6ee Mon Sep 17 00:00:00 2001
From: thuanle <tl@thuanle.me>
Date: Sun, 26 Apr 2026 17:50:41 +0700
Subject: [PATCH] docs: document required environment variables

Expand README with env setup, required TELEGRAM_TOKEN,
optional LOG_ENV and ADMIN_CHAT_ID, plus run notes.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
---
 README.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 65cff25..4d0bfad 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,31 @@
-# crypto price bot
\ No newline at end of file
+# 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`.