Merge branch 'master' of https://github.com/Bawnorton/MixinSquared

Author: Bawnorton

README.md

@@ -19,21 +19,21 @@ For each platform:<br>
 
 ```gradle
 dependencies {
-    include(implementation(annotationProcessor("com.github.bawnorton.mixinsquared:mixinsquared-fabric:0.1.2-beta.4")))
+    include(implementation(annotationProcessor("com.github.bawnorton.mixinsquared:mixinsquared-fabric:0.1.2-beta.5")))
 }
 ```
 
 </details>
 <details><summary>Forge 1.18.2+ with ForgeGradle</summary>
 
-### This will not work for Forge 1.18.1 and below, See [Initialization](#initialization).
+### This will not work for Forge 1.18.1 and below, see `Any Other Platform`
 
 ```gradle
 dependencies {
     // MixinSquared's annotationProcessor MUST be registered BEFORE Mixin's one.
-    implementation(annotationProcessor("com.github.bawnorton.mixinsquared:mixinsquared-common:0.1.2-beta.4"))
-    implementation(jarJar("com.github.bawnorton.mixinsquared:mixinsquared-forge:0.1.2-beta.4")) {
-        jarJar.ranged(it, "[0.1.2-beta.4,)")
+    implementation(annotationProcessor("com.github.bawnorton.mixinsquared:mixinsquared-common:0.1.2-beta.5"))
+    implementation(jarJar("com.github.bawnorton.mixinsquared:mixinsquared-forge:0.1.2-beta.5")) {
+        jarJar.ranged(it, "[0.1.2-beta.5,)")
     }
 }
 ```
@@ -44,39 +44,69 @@ dependencies {
 ```gradle
 dependencies {
     // MixinSquared's annotationProcessor MUST be registered BEFORE Mixin's one.
-    implementation(annotationProcessor("com.github.bawnorton.mixinsquared:mixinsquared-common:0.1.2-beta.4"))
-    implementation(jarJar("com.github.bawnorton.mixinsquared:mixinsquared-neoforge:0.1.2-beta.4")) {
-        jarJar.ranged(it, "[0.1.2-beta.4,)")
+    implementation(annotationProcessor("com.github.bawnorton.mixinsquared:mixinsquared-common:0.1.2-beta.5"))
+    implementation(jarJar("com.github.bawnorton.mixinsquared:mixinsquared-neoforge:0.1.2-beta.5")) {
+        jarJar.ranged(it, "[0.1.2-beta.5,)")
     }
 }
 ```
 
 </details>
 <details><summary>Forge 1.18.2+ with Architectury Loom</summary>
 
-### This will not work for Forge 1.18.1 and below, See [Initialization](#initialization).
+### This will not work for Forge 1.18.1 and below, see `Any Other Platform`
 
 ```gradle
 dependencies {
-    implementation(annotationProcessor("com.github.bawnorton.mixinsquared:mixinsquared-common:0.1.2-beta.4"))
-    implementation(include("com.github.bawnorton.mixinsquared:mixinsquared-forge:0.1.2-beta.4"))
+    implementation(annotationProcessor("com.github.bawnorton.mixinsquared:mixinsquared-common:0.1.2-beta.5"))
+    implementation(include("com.github.bawnorton.mixinsquared:mixinsquared-forge:0.1.2-beta.5"))
 }
 ```
 
 </details>
 
-## Initialization
+</details>
+<details><summary>Any Other Platform</summary>
+
+This is only a rough guide. You will need to look into the specifics of setting up ShadowJar for your platform.
+
+```gradle
+plugins {
+    id "com.github.johnrengelman.shadow" version "8.1.0"
+}
+
+configurations {
+    implementation.extendsFrom shadow
+}
+
+repositories {
+    maven { url = "https://jitpack.io" }
+}
 
-If you are on Fabric, Quilt or Forge 1.18.2+ MixinSquared will automatically initiate, otherwise you will need to call:
+dependencies {
+    shadow(annotationProcessor("com.github.bawnorton.mixinsquared:mixinsquared-common:0.1.2-beta.5"))
+}
+
+shadowJar {
+    configurations = [project.configurations.shadow]
+    relocate("com.github.bawnorton.mixinsquared", "your.package.goes.here.mixinsquared")
+    mergeServiceFiles()
+}
+```
+
+To initialize MixinSquared, simply call
 
 ```java
 MixinSquaredBootstrap.init();
+```
+In the `onLoad` method inside a [IMixinConfigPlugin](https://jenkins.liteloader.com/view/Other/job/Mixin/javadoc/org/spongepowered/asm/mixin/extensibility/IMixinConfigPlugin.html)
 
-// If you intend to use a MixinCanceller, you will need to call:
+If you intend to use a MixinCanceller, you will need to also call:
+```
 MixinCancellerRegistrar.register(new YourMixinCancellerImpl());
 ```
 
-In the `onLoad` method inside a [IMixinConfigPlugin](https://jenkins.liteloader.com/view/Other/job/Mixin/javadoc/org/spongepowered/asm/mixin/extensibility/IMixinConfigPlugin.html)
+</details>
 
 ### Credits