From b881a29c7fbd79c5f4b2ee141416d879d065c404 Mon Sep 17 00:00:00 2001
From: got2bhockey <got2bhockey@users.noreply.github.com>
Date: Tue, 6 Sep 2022 11:27:30 -0400
Subject: [PATCH] Updated README.md with command usage and updated proper
 defaults

---
 README.MD | 44 ++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 42 insertions(+), 2 deletions(-)

diff --git a/README.MD b/README.MD
index fc0583d..3b09595 100644
--- a/README.MD
+++ b/README.MD
@@ -1,19 +1,52 @@
 ## MapVote
 The `MapVote` plugin for squad js based on the original version https://github.com/maskedmonkyman/squad-js-map-vote
+
+### Commands
+
+#### User Commands
+- `!vote help` - sends possbile commands to a player in the from of a warning
+- `!vote choices` - sends choices to player in the from of a warning
+- `!vote results` - sends player the results in a warning
+
+#### Admin Commands
+- `!vote start` - Starts a vote with 6 layers, random modes
+- `!vote cancel` - Cancels current round of voting
+- `!vote restart` - Restarts voting with 6 random maps and modes
+- `!vote broadcast` - Broadcasts current voting results - happens every 7m automatically
+
+##### Vote by modes
+- `!vote start *_raas` - Starts a vote with 6 layers, all RAAS
+- `!vote start *_aas` - Starts a vote with 6 layers, all AAS
+- `!vote start *_inv` - Starts a vote with 6 layers, all INV
+
+##### Vote by map
+- `!vote start yeh gor lash gor albas` - Starts a vote with X maps, random modes
+
+##### Vote by map + mode, mixed
+- `!vote start yeh_raas gor_raas lash_inv gor albas_inv` - Starts a vote with X maps, X modes
+
+
 ### Options
+#### commandPrefix
+###### Description
+The command name to use in chat.
+###### Default
+```
+!vote
+```
 #### minPlayersForVote
 ###### Description
 The number of players needed on the server for a vote to start.
 ###### Default
 ```
-30
+40
 ```
 #### voteWaitTimeFromMatchStart
 ###### Description
 The time in mins from the start of a round to the start of a new map vote.
 ###### Default
 ```
-10
+15
 ```
 #### voteBroadcastInterval
 ###### Description
@@ -29,6 +62,13 @@ Set a seeding layer if server has less than 20 players.
 ```json
 true
 ```
+#### numberRecentMapsToExlude
+###### Description
+The random layer list will not include the X recent maps
+###### Default
+```
+4
+```
 #### gamemodeWhitelist
 ###### Description
 The random layer list will be generated with only selected gamemodes.