mirror of
https://github.com/LightZirconite/Microsoft-Rewards-Bot.git
synced 2026-01-20 21:53:56 +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:
16
docs/running.md
Normal file
16
docs/running.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Running the Bot
|
||||
|
||||
## What it does
|
||||
Explains the basic commands to start the bot.
|
||||
|
||||
## How to use
|
||||
- `npm start` — builds if needed and runs once.
|
||||
- `npm run dev` — runs from source while you edit.
|
||||
- `npm run dashboard` — starts the web dashboard.
|
||||
- `npm run creator` — opens account creation mode.
|
||||
- `npm run docker:compose` — runs inside Docker with the provided compose file.
|
||||
|
||||
## Example
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
Reference in New Issue
Block a user