Merge pull request 'Update the readme with the new cadence value' (#16) from mdiluz-patch-2 into main
All checks were successful
Test, Build and Publish / test (push) Successful in 34s
Test, Build and Publish / build-and-push-images (push) Successful in 1m19s

Reviewed-on: #16
This commit is contained in:
mdiluz 2024-09-22 14:43:39 +01:00
commit dabd0d9b18

View file

@ -17,7 +17,7 @@ Matchy supports a bunch of user, `matcher` and bot owner commands. `/` commands
| /pause | user | Pauses the user for `days: int` days | | /pause | user | Pauses the user for `days: int` days |
| /list | user | Lists the current matchees and scheduled matches | | /list | user | Lists the current matchees and scheduled matches |
| /match | user* | Shares a preview of the matchee groups of size `group_min: int` with the user. *Offers a button to post the match to `matcher` users | | /match | user* | Shares a preview of the matchee groups of size `group_min: int` with the user. *Offers a button to post the match to `matcher` users |
| /schedule | `matcher` | Schedules a match every week with `group_min: int` users on `weekday: int` day and at `hour: int` hour. Can pass `cancel: True` to stop the schedule | | /schedule | `matcher` | Schedules a match every week with `group_min: int` users on `weekday: int` and at `hour: int`, on a weekly `cadence: int`.<br>Can pass `cancel: True` to stop the schedule |
| /cancel | `matcher` | Cancels any scheduled matches in this channel | | /cancel | `matcher` | Cancels any scheduled matches in this channel |
| $sync | bot owner | Syncs bot command data with the discord servers | | $sync | bot owner | Syncs bot command data with the discord servers |
| $close | bot owner | Closes the bot connection so the bot quits safely | | $close | bot owner | Closes the bot connection so the bot quits safely |