Create README.md

README.md

@@ -0,0 +1,36 @@
+# Pit Stats
+
+Advanced Stats Viewer for The Hypixel Pit.
+
+## Features
+
+### Stats Viewer
+
+The main purpose of this mod is to provide an improved version of /view command for viewing inventory/enderchest, selected perks/killstreaks and various Pit statistics.
+
+Use **/pit <name> (or /pitstats, /pitinfo)** command to open the statistics viewer.
+
+You can watch a review of this on YouTube: https://youtu.be/RQRD0_a83fI. Please note that this video is slightly outdated.
+
+### Required Pants for Mystic Items
+
+Display required pants color to Tier III for fresh/T1/T2 mystic items. Enabled by default.
+
+Enable/disable this feature: **/pit pants**.
+
+![](https://media.discordapp.net/attachments/731504203591319553/819647045153456178/unknown.png)
+
+## Getting Started
+
+### Prerequisites
+
+* Minecraft 1.8.9
+* Forge 11.15.1.2318 (latest)
+
+### Installation
+
+Download the jar from [latest release](https://github.com/mdashlw/pit-stats/releases/latest) and drop it to `.minecraft/mods` folder.
+
+## License
+
+This project is licensed under the terms of the MIT license.