Add README.MD

README.MD

@@ -0,0 +1,41 @@
+**NVus Prison Gold Edition**
+
+
+
+**Main Features:**
+- Most features can be toggled on or off.
+- Spawn prisoners in a prison jumpsuit (orange leather armor).
+- Restrict prisoners from changing their armor.
+- Added restricted items to a banned_items.yml file to restrict them being used, crafted or even transfered to storage.
+- Enable AutoPickup for prisoners when they mine/dig blocks.
+- Enable AutoSwitch for prisoners to auto switch to the correct tool when mining/digging.
+
+
+**Permissions:**
+- To enable the prisoner features players who are considered prisoners should have the permission nvus.prisoner.
+- Just in case, all non-prisoners and players who are no longer considered a prisoner should have the permission nvus.prisoner NEGATED.
+
+The permission nvus.admin is needed for all in-game commands!
+
+
+**Commands:**
+These commands require the permission ' nvus.admin '
+
+    /nvus reload - Reload the config files if changed externally like adding additional banned items or materials to the auto switch list etc.
+
+    /nvus version - Shows the current plugin version number.
+
+    /nvus autopickup true|false - Toggle auto pickup for all prisoners on the server.
+
+    /nvus autoswitch true|false - Toggle auto switching of tools for all prisoners on the server.
+
+    /nvus prisonerarmor true|false - Toggle if prisoners are given the default prisoner armor (orange leather armor set).
+
+    /nvus restrictarmor true|false - Toggle if prisoners can change/remove their armor.
+
+
+**Needs Implemented:**
+- Prison Gangs
+- Prevent Prisoner Tool Damage
+- Prison Credits
+- Prison Mines