Skip to content

Commit 8fc3e16

Browse files
committed
feat: update README with environment variable setup for browser login and IMAP auto-OTP
1 parent c487ba7 commit 8fc3e16

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@ Our documentation covers everything from basic setup to advanced trading strateg
206206
| [🤖 **Trading Bots**](https://chipadevteam.github.io/AxiomTradeAPI-py/trading-bots/) | Automated strategies, bot frameworks | Advanced |
207207
| [**Performance**](https://chipadevteam.github.io/AxiomTradeAPI-py/performance/) | Optimization, scaling, monitoring | Advanced |
208208
| [🛡️ **Security**](https://chipadevteam.github.io/AxiomTradeAPI-py/security/) | Best practices, secure deployment | All Levels |
209+
| [📝 **Release Notes 1.1.6**](https://chipadevteam.github.io/AxiomTradeAPI-py/release-1-1-6/) | Browser login, IMAP auto-OTP | All Levels |
209210
| [📝 **Release Notes 1.1.5**](https://chipadevteam.github.io/AxiomTradeAPI-py/release-1-1-5/) | Cloudflare bypass, auto token refresh | All Levels |
210211

211212
## 🏆 Professional Use Cases
@@ -332,11 +333,20 @@ Our SDK is optimized for professional trading applications:
332333

333334
### Environment Variables
334335
```bash
335-
# Authentication
336+
# ── Credentials (for browser login) ──────────────────────────────────────────
337+
export AXIOM_EMAIL="you@example.com"
338+
export AXIOM_PASSWORD="yourpassword"
339+
340+
# ── IMAP auto-OTP (optional — enables fully zero-touch login) ─────────────────
341+
export AXIOM_IMAP_PASSWORD="your_email_password" # Gmail: use an App Password
342+
export AXIOM_IMAP_USER="real@yourdomain.com" # only if AXIOM_EMAIL is an alias
343+
export AXIOM_IMAP_HOST="imap.hostinger.com" # only if auto-detection is wrong
344+
345+
# ── Token authentication (for serverless / CI) ────────────────────────────────
336346
export AXIOM_ACCESS_TOKEN="your-access-token"
337347
export AXIOM_REFRESH_TOKEN="your-refresh-token"
338348

339-
# Cloudflare bypass (get from browser DevTools → Application → Cookies → axiom.trade)
349+
# ── Cloudflare (captured automatically by browser login) ──────────────────────
340350
export CF_CLEARANCE="your-cf_clearance-cookie-value"
341351

342352
# API Configuration

0 commit comments

Comments
 (0)