mirror of
https://github.com/LightZirconite/Microsoft-Rewards-Bot.git
synced 2026-01-10 01:06:17 +00:00
Refactor documentation and add new features
- Updated index.md to simplify structure and focus on task-oriented guides. - Revised notifications.md to streamline setup instructions and improve clarity. - Added report-error.js for structured error reporting to Discord. - Introduced account-creation.md and configuration.md for detailed guidance on account setup and bot configuration. - Created dashboard.md, docker.md, error-reporting.md, modes.md, running.md, scheduling.md, setup.md, troubleshooting.md, and update.md for comprehensive documentation on respective features and usage. - Updated package-lock.json and package.json to include peer dependencies.
This commit is contained in:
23
docs/configuration.md
Normal file
23
docs/configuration.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Configuration
|
||||
|
||||
## What it does
|
||||
Controls how the bot behaves through `src/config.jsonc`.
|
||||
|
||||
## How to use
|
||||
- Open `src/config.jsonc` and edit only the fields you need.
|
||||
- Keep `humanization.enabled` true to mimic real usage.
|
||||
- Adjust `workers` to enable or disable search, quizzes, and promotions.
|
||||
- Set `scheduling.enabled` to automate runs.
|
||||
|
||||
## Example
|
||||
```jsonc
|
||||
{
|
||||
"humanization": { "enabled": true },
|
||||
"workers": {
|
||||
"doDesktopSearch": true,
|
||||
"doMobileSearch": true,
|
||||
"doDailySet": true
|
||||
},
|
||||
"scheduling": { "enabled": false }
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user