Skip to content

Commit

Permalink
docs(update_usageDocs #115): update docs on using the bot
Browse files Browse the repository at this point in the history
  • Loading branch information
DasithKuruppu committed Feb 12, 2023
1 parent 1b391a8 commit 6eea018
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This is a simple discord bot buit to interact with some discord users.
[![Node][node.js]][node-url]
[![Typescript][typescript]][typescript-url]
[![Pulumi][pulumi]][pulumi-url]
[![AWS][aws]][pulumi-url]
[![AWS][aws]][aws-url]

## Test coverage

Expand Down
26 changes: 13 additions & 13 deletions docs/usage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Currently the bot supports the below mentioned commands.
# Commands

## info
## /info

### Description

Expand All @@ -13,7 +13,7 @@ List some info about the bot

None

## ask
## /ask

### Description

Expand All @@ -23,7 +23,7 @@ Ask or say anything to the bot

- `message`: Ask something from the bot (required)

## request_role
## /request

### Description

Expand All @@ -42,7 +42,7 @@ Choose a type of request to make.
- `raid_summary`: Request summary of the upcoming raids
- `invite_link`: Get an invite link to invite users.

## remove_raidUser
## /remove_raidUser

### Description

Expand All @@ -54,15 +54,15 @@ Remove a user from an event or raid.
- `user`: The user you want to remove. (required)
- `raid_id`: The ID of the raid you want the user removed from. (required)
- `reason`: Reason for removing (optional)
- `Did not show up`: Did not show up (value: "did not show up")
- `Were unable to join`: Were unable to join (value: "were unable to join")
- `Did not meet queue requirements`: Did not meet queue requirements (value: "did not meet queue requirements")
- `Were wiping floor all day`: Were wiping floor all day (value: "Were wiping floor all day")
- `Are too ugly`: Are too ugly (value: "are too ugly")
- `Could not hold aggro`: Could not hold aggro (value: "could not hold aggro")
- `Ignored mechanics`: Ignored mechanics (value: "ignored mechanics")

## create_raid
- `Did not show up`
- `Were unable to join`
- `Did not meet queue requirements`
- `Were wiping floor all day`
- `Are too ugly`
- `Could not hold aggro`
- `Ignored mechanics`

## /create_raid

### Description

Expand Down

0 comments on commit 6eea018

Please sign in to comment.