Create README.md

talran · Sep 3, 2018 · 2989d46 · 2989d46
1 parent 00de74f
commit 2989d46
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# Monster Hunter: World - DPS Overlay
+
+This mod displays the damage breakdown and DPS of your current team. 
+
+
+## Instructions
+
+1. Run Monster Hunter: World
+2. Run this mod and adjust the position and size of the overlay
+3. Enjoy the hunt!
+
+## Todo 
+
+- [x] Implement DPS calculation
+- [x] Fix numbers for subsequent hunts
+- [ ] Fix character clipping
+- [ ] Publish to NexusMods