From 136e32a1b954739dd9254c70a20fdb9eed59c874 Mon Sep 17 00:00:00 2001 From: Josh Creek Date: Mon, 26 Oct 2020 00:11:03 +0000 Subject: [PATCH] feat(*): Add readme file --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1043aa7..9008861 100644 --- a/README.md +++ b/README.md @@ -1 +1,15 @@ -# denBot \ No newline at end of file +# denBot + +A queue bot to enable multiple (default 4) Pokémon players to go on an adventure together via Discord. + +## Features + +Users can join and leave a queue. When the queue is full users are DMed a code to join the in-game lobby. + +Commands: + +* q - Join the queue +* lq - Leave the queue +* sq - Show the queue +* cq - Clear the queue (admin-only, not to be shared with normal users) +* ru - Remove a tagged user from the queue (admin-only, not to be shared with normal users)