Explorar o código

add useable README

Noah Vogt %!s(int64=4) %!d(string=hai) anos
pai
achega
f375cf75d2
Modificáronse 1 ficheiros con 11 adicións e 1 borrados
  1. 11 1
      README.md

+ 11 - 1
README.md

@@ -1 +1,11 @@
-# NoPotionOffset
+# NoPotionOffset
+
+This mod removes the annoying inventory offset that occurs when a potion effect is active. It supports both Forge and Fabric mod loaders.
+
+Here you can see how it looks ingame:
+![demo screenshot](https://cdn.discordapp.com/attachments/687641726080516116/818468029167304734/2021-03-08_13.52.27.png)
+
+## compiling
+To build this project, simply run `gradle build`.
+
+if it the provided releases don't work for you, just change the git branch using `git checkout [branch]` and/or try using a different version/build of gradle.