Move installation guide to GitHub wiki

srnyx · Jun 25, 2023 · 6837df8 · 6837df8
1 parent db94378
commit 6837df8
Showing 1 changed file with 4 additions and 106 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ This may be different for other plugins that **aren't** mine, though. Just check
 
 ### Download (read above)
 
-- **Stable:** You can download the latest **stable** version at [Modrinth](https://annoying-api.srnyx.com/modrinth), [Hangar](https://annoying-api.srnyx.com/hangar), [Polymart](https://annoying-api.srnyx.com/polymart), [BuiltByBit](https://annoying-api.srnyx.com/builtbybit), [Spigot](https://annoying-api.srnyx.com/spigot), [Bukkit](https://annoying-api.srnyx.com/bukkit), or [GitHub](https://annoying-api.srnyx.com/releases/latest)
+- **Stable:** You can download the latest **stable** version at [Modrinth](https://annoying-api.srnyx.com/modrinth), [Hangar](https://annoying-api.srnyx.com/hangar), [Spigot](https://annoying-api.srnyx.com/spigot), [Bukkit](https://annoying-api.srnyx.com/bukkit), or [GitHub](https://annoying-api.srnyx.com/releases/latest)
 - **Snapshot:** You can download the latest **snapshot** version at [GitHub Actions](https://annoying-api.srnyx.com/snapshot)
 
 ### Wiki
@@ -21,110 +21,8 @@ You can find the wiki at [annoying-api.srnyx.com/wiki](https://annoying-api.srny
 
 ## Developers
 
-You can find the Javadocs at [annoying-api.srnyx.com/javadocs](https://annoying-api.srnyx.com/javadocs). The wiki above may also contain some helpful information
+You can find the Javadocs at [annoying-api.srnyx.com/javadocs](https://annoying-api.srnyx.com/javadocs). The wiki above will also contain some helpful information
 
-### Importing
+### Installation
 
-You can import the API using [Jitpack](https://annoying-api.srnyx.com/jitpack). It's **HIGHLY** recommended to implement the API, all the examples below will implement it. Make sure to replace `VERSION` with the version you want.
-
-- **Gradle Kotlin** (`build.gradle.kts`)**:**
-```kotlin
-// Required plugins
-plugins {
-  java
-  id("com.github.johnrengelman.shadow") version "7.1.2" // https://github.com/johnrengelman/shadow/releases/latest
-}
-// Jitpack repository
-repositories {
-  maven("https://jitpack.io")
-}
-// AnnoyingAPI dependency declaration
-dependencies {
-    implementation("xyz.srnyx", "annoying-api", "VERSION")
-}
-// It's recommended to relocate the API to avoid conflicts
-tasks {
-  build {
-    relocate("xyz.srnyx.annoyingapi", "YOUR.PACKAGE.annoyingapi")
-  }
-}
-```
-- **Gradle Groovy** (`build.gradle`)**:**
-```groovy
-// Required plugins
-plugins {
-  id 'java'
-  id 'com.github.johnrengelman.shadow' version '7.1.2' // https://github.com/johnrengelman/shadow/releases/latest
-}
-// Jitpack repository
-repositories {
-    maven { url = 'https://jitpack.io' }
-}
-// AnnoyingAPI dependency declaration
-dependencies {
-    implementation 'xyz.srnyx:annoying-api:VERSION'
-}
-// It's recommended to relocate the API to avoid conflicts
-shadowJar {
-    relocate 'xyz.srnyx.annoyingapi', 'YOUR.PACKAGE.annoyingapi'
-}
-```
-* **Maven** (`pom.xml`)**:**
-    * Shade plugin
-  ```xml
-  <build>
-    <plugins>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-shade-plugin</artifactId>
-        <version>3.4.1</version>
-        <executions>
-          <execution>
-            <phase>package</phase>
-            <goals>
-              <goal>shade</goal>
-            </goals>
-          </execution>
-        </executions>
-        <configuration>
-        <!-- Exclude resources to avoid conflicts -->
-          <filters>
-            <filter>
-              <artifact>xyz.srnyx:*</artifact>
-              <excludes>
-                <exclude>META-INF/*.MF</exclude>
-                <exclude>plugin.yml</exclude>
-              </excludes>
-            </filter>
-          </filters>
-          <relocations>
-          <!-- It's recommended to relocate the API to avoid conflicts -->
-            <relocation>
-                <pattern>xyz.srnyx.annoyingapi</pattern>
-                <shadedPattern>YOUR.PACKAGE.annoyingapi</shadedPattern>
-            </relocation>
-          </relocations>
-        </configuration>
-      </plugin>
-    </plugins>
-  </build>
-  ```
-    * Jitpack repository
-  ```xml
-   <repositories>
-        <repository>
-            <id>jitpack</id>
-            <url>https://jitpack.io</url>
-        </repository>
-    </repositories>
-  ```
-    * AnnoyingAPI dependency declaration
-  ```xml
-    <dependencies>
-        <dependency>
-            <groupId>xyz.srnyx</groupId>
-            <artifactId>annoying-api</artifactId>
-            <version>VERSION</version>
-        </dependency>
-    </dependencies>
-  ```
+To install the API, please see [the documentation](https://annoying-api.srnyx.com/wiki/installation) on GitHub