Now with a README

README.md

@@ -0,0 +1,33 @@
+# Supported platforms
+
+Fabric (required for platform mod resolution)
+
+Java >= 17
+
+# Features
+
+## Modding compat
+
+A mod compatibility mixin plugin is made available at
+`com.nerjal.moddingutils.compat.CompatMixinPLugin` and will use the `Compat` annotation
+to allow you to make mixins only be applied with their respective dependencies are
+loaded.
+
+Dependencies need a mod ID at least, but can also include filtering base on authors names
+as well as version ranges.
+
+# Usage
+
+Add the `https://maven.nerjal.com/releases/` maven repository to your project,
+and import the `com.nerjal:ModdingUtils:<VERSION>` artifact in your project.
+
+You are free to bundle this project into yours.
+
+Don't hesitate to add a dependency to "the same main version as yours" in your project
+manifest (e.g. `"moddingutils": "~${moddingutils_version}"`) to avoid trying to load
+with breaking changes brought by some other project including a more recent version of
+ModdingUtils.
+
+## Latest version
+
+[1.0](https://maven.nerjal.com/#/releases/com/nerjal/ModdingUtils/1.0)