mirror of
https://github.com/TheNetsky/Microsoft-Rewards-Script.git
synced 2026-01-11 10:56:17 +00:00
dc7e122bce
* feat: Implement edge version fetching with retry logic and caching * chore: Update version to 2.1.0 in package.json * fix: Update package version to 2.1.0 and enhance user agent metadata * feat: Enhance 2FA handling with improved TOTP input and submission logic * fix: Refactor getSystemComponents to improve mobile user agent string generation * feat: Add support for cron expressions for advanced scheduling * feat: Improve humanization feature with detailed logging for off-days configuration * feat: Add live log streaming via webhook and enhance logging configuration * fix: Remove unused @types/cron-parser dependency from devDependencies * feat: Add cron-parser dependency and enhance Axios error handling for proxy authentication * feat: Enhance dashboard data retrieval with retry logic and diagnostics capture * feat: Add ready-to-use sample configurations and update configuration settings for better customization * feat: Add buy mode detection and configuration methods for enhanced manual redemption * feat: Migrate configuration from JSON to JSONC format for improved readability and comments support feat: Implement centralized diagnostics capture for better error handling and reporting fix: Update documentation references from config.json to config.jsonc chore: Add .vscode to .gitignore for cleaner project structure refactor: Enhance humanization and diagnostics capture logic in BrowserUtil and Login classes * feat: Reintroduce ambiance declarations for the 'luxon' module to unlock TypeScript * feat: Update search delay settings for improved performance and reliability * feat: Update README and SECURITY documentation for clarity and improved data handling guidelines * Enhance README and SECURITY documentation for Microsoft Rewards Script V2 - Updated README.md to improve structure, add badges, and enhance clarity on features and setup instructions. - Expanded SECURITY.md to provide detailed data handling practices, security guidelines, and best practices for users. - Included sections on data flow, credential management, and responsible use of the automation tool. - Added a security checklist for users to ensure safe practices while using the script. * feat: Réorganiser et enrichir la documentation du README pour une meilleure clarté et accessibilité * feat: Updated and reorganized the README for better presentation and clarity * feat: Revised and simplified the README for better clarity and accessibility * Update README.md
2.7 KiB
2.7 KiB
📚 Microsoft Rewards Script V2 Docs
🎯 Your companion for mastering the automation stack
Curated guides, verified against the current codebase
🚀 Quick Navigation
Essential Setup
| Guide | Why you should read it |
|---|---|
| 🎬 Getting Started | Install, configure, and run the bot in minutes |
| 👤 Accounts & 2FA | Add Microsoft accounts, enable TOTP, and secure logins |
| ⚙️ Configuration Reference | Understand every option in src/config.jsonc |
Run & Operate
| Guide | Focus |
|---|---|
| ⏰ Scheduling | Cron-style automation and daily cadence |
| 🐳 Docker | Container deployment with prewired headless settings |
| 🛠️ Diagnostics | Troubleshooting, log capture, and support checklist |
| 🧠 Humanization | Natural browser behavior and ban avoidance |
| 🌐 Proxy Setup | Per-account proxy routing and geo-tuning |
| 📊 Job State | How runs persist progress and recover |
| 🔄 Auto Update | Keep the script current without manual pulls |
| 🛡️ Security Notes | Threat model, secrets handling, and best practices |
Notifications & Control
| Guide | Purpose |
|---|---|
| 📱 NTFY Push | Real-time phone notifications |
| <EFBFBD> Discord Webhooks | Detailed run summaries in your server |
Special Modes
| Guide | Purpose |
|---|---|
| 💳 Buy Mode | Assisted manual redemption and live monitoring |
🧭 Reading Paths
- First install: Getting Started → Accounts & 2FA → Configuration Reference → Scheduling or Docker
- Docker-first: Getting Started prerequisites → Docker → Diagnostics → Notifications (NTFY or Webhooks)
- Optimizing runs: Humanization → Schedule tuning → Proxy → Job State → Update
Each guide now links back to the most relevant follow-up topics so you can jump between setup, operations, and troubleshooting without losing context.
🔗 Useful Shortcuts
- Need sample configs? → Config presets
- Want a scripted environment? → Scheduler
- Looking to self-audit? → Diagnostics + Security
If something feels out of sync with the code, open an issue or ping us on Discord—the docs are maintained to match the current defaults (src/config.jsonc, visible browsers by default, Docker headless enforcement via FORCE_HEADLESS=1).