aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8b1c65e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Minecraft Trivia RedBot Cog
+
+Guess minecraft crafting recipes the fastest.
+
+## Installation
+
+> This is a cog for the [Red-DiscordBot V3](https://github.com/Cog-Creators/Red-DiscordBot). You need to have a working V3 Redbot in order to install this cog.
+
+```
+[p]load downloader
+[p]repo add minecrafttrivia https://github.com/romangraef/RedCog-MinecraftTrivia
+[p]cog install minecrafttrivia minecrafttriva
+[p]load minecrafttrivia
+```
+
+## Usage
+
+```
+[p]minecrafttrivia - Start a game
+[p]minecrafttrivia high - Show highscores
+[p]minecrafttrivia lead - Show total score leaderboard
+```