Create README.md

ontrigger · Apr 5, 2019 · b5f761f · b5f761f
1 parent 5022ab0
commit b5f761f
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+# RoR2Mods.ItemStats
+Provides current stack bonuses for an item in the tooltip
+
+![demo](https://i.imgur.com/24ho8CG.png)
+# Installation
+First thing you'll need is the modloader. If you don't have it, get it [here](https://github.com/meepen/ror2-modloader/) and follow the installation instructions.
+
+Afterwards, get the built assembly from releases and put it in your mods folder. That's it!
+# Building
+Open the solution, link the libraries in the Lib folder, DL the required NuGet package and compile.