From 0250ad80c81c078a29ef350ea431449353e9909b Mon Sep 17 00:00:00 2001
From: William <will27528@gmail.com>
Date: Sun, 11 Jun 2023 13:08:23 +0100
Subject: [PATCH] docs: Use new repo

---
 docs/API.md | 41 +++++++++++++++++++++++++----------------
 1 file changed, 25 insertions(+), 16 deletions(-)

diff --git a/docs/API.md b/docs/API.md
index c84b70df..ee31e87f 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -1,11 +1,20 @@
-[![HuskSync banner](https://raw.githubusercontent.com/WiIIiam278/HuskSync/master/images/banner.png)](https://github.com/WiIIiam278/HuskSync)
-# HuskSync API v2
-![](https://jitpack.io/v/WiIIiam278/HuskSync.svg)
-
 The HuskSync API provides methods for retrieving and updating user data, as well as a number of events for tracking when user data is synced and saved. 
 
-The API is distributed via [JitPack](https://jitpack.io/#net.william278/HuskSync). Please note that the HuskSync v1 API is not compatible.
-(Some) javadocs are also available to view on Jitpack [here](https://javadoc.jitpack.io/net/william278/HuskSync/latest/javadoc/).
+## Compatibility
+[![Maven](https://repo.william278.net/api/badge/latest/releases/net/william278/husksync?color=00fb9a&name=Maven&prefix=v)](https://repo.william278.net/#/releases/net/william278/husksync/)
+
+The HuskSync API shares version numbering with the plugin itself for consistency and convenience. Please note minor and patch plugin releases may make API additions and deprecations, but will not introduce breaking changes without notice.
+
+| API Version |  HuskSync Versions  | Supported |
+|:-----------:|:--------------------:|:---------:|
+|    v2.x     | _v2.0&mdash;Current_ |     ✅     |
+|    v1.x     | _v1.0&mdash;v1.4.1_  |    ❌️     |
+
+<details>
+<summary>Targeting older versions</summary>
+
+HuskSync versions prior to `v2.2.5` are distributed on [JitPack](https://jitpack.io/#/net/william278/HuskSync), and you will need to use the `https://jitpack.io` repository instead.
+</details>
 
 ## Table of contents
 1. Adding the API to your project
@@ -17,21 +26,21 @@ The API is distributed via [JitPack](https://jitpack.io/#net.william278/HuskSync
 <details>
 <summary>Maven setup information</summary>
 
-- Add the repository to your `pom.xml` as per below.
+Add the repository to your `pom.xml` as per below. You can alternatively specify `/snapshots` for the repository containing the latest development builds (not recommended).
 ```xml
 <repositories>
     <repository>
-        <id>jitpack.io</id>
-        <url>https://jitpack.io</url>
+        <id>william278.net</id>
+        <url>https://repo.william278.net/releases</url>
     </repository>
 </repositories>
 ```
-- Add the dependency to your `pom.xml` as per below. Replace `version` with the latest version of HuskSync (without the v): ![Latest version](https://img.shields.io/github/v/tag/WiIIiam278/HuskSync?color=%23282828&label=%20&style=flat-square)
+Add the dependency to your `pom.xml` as per below. Replace `VERSION` with the latest version of HuskSync (without the v): ![Latest version](https://img.shields.io/github/v/tag/WiIIiam278/HuskSync?color=%23282828&label=%20&style=flat-square)
 ```xml
 <dependency>
     <groupId>net.william278</groupId>
-    <artifactId>HuskSync</artifactId>
-    <version>version</version>
+    <artifactId>husksync</artifactId>
+    <version>VERSION</version>
     <scope>provided</scope>
 </dependency>
 ```
@@ -41,19 +50,19 @@ The API is distributed via [JitPack](https://jitpack.io/#net.william278/HuskSync
 <details>
 <summary>Gradle setup information</summary>
 
-- Add the dependency like so to your `build.gradle`:
+Add the dependency as per below to your `build.gradle`. You can alternatively specify `/snapshots` for the repository containing the latest development builds (not recommended).
 ```groovy
 allprojects {
 	repositories {
-		maven { url 'https://jitpack.io' }
+		maven { url 'https://repo.william278.net/releases' }
 	}
 }
 ```
-- Add the dependency as per below. Replace `version` with the latest version of HuskSync (without the v): ![Latest version](https://img.shields.io/github/v/tag/WiIIiam278/HuskSync?color=%23282828&label=%20&style=flat-square)
+Add the dependency as per below. Replace `VERSION` with the latest version of HuskSync (without the v): ![Latest version](https://img.shields.io/github/v/tag/WiIIiam278/HuskSync?color=%23282828&label=%20&style=flat-square)
 
 ```groovy
 dependencies {
-    compileOnly 'net.william278:HuskSync:version'
+    compileOnly 'net.william278:husksync:VERSION'
 }
 ```
 </details>