Update README.md

README.md

@@ -1,2 +1,17 @@
 # CastleSiege
-Minecraft 1.16 Plugin
+A Minecraft 1.16 Plugin
+
+This plugin is for a minigame called Castle Siege. 30 waves of custom Zombies will spawn and attack your castle. Defend the villagers throughout the siege to win.
+
+# Prerequisites
+You will need MythicMobs and WorldEdit for the plugin to function properly. The MythicMobs config used will be provided, but feel free to customize it and use your own mobs.
+
+# Commands
+- /siege start <wave number (optional)>: This will start the siege from a specific wave if provided, or wave 1 if no wave is given
+- /siege stop: This will end the siege prematurely. The mobs that are already alive will not be despawned. If you wish to despawn them, type /mm m killall
+- /siege setregion: Sets the region where mobs will spawn during the siege. Select the region using the WorldEdit wand. Mobs will spawn 1 block above the highest point in the region, so if you select a flat ground region, the mobs will all spawn on the ground, which is probably the desired behavior.
+
+# Setup
+You will need to configure your MythicMobs to patrol to coordinates that fit for your map. This is not done through the CastleSiege plugin. Additionally, if you want to change which mobs spawn each wave, you can modify the HashMaps at the end of the main class. Also, the villagers need to be spawned manually before each playthrough. It is not automatic because different people may have different maps where they wish to put the villagers in different places.
+
+If you have any questions about the plugin you can contact me at jason.cramer@uconn.edu