From f2dbb59c4ceec3cdb59f42aea133b9a4236a26cb Mon Sep 17 00:00:00 2001
From: Jakob K <bluefireolymp@gmail.com>
Date: Tue, 15 Jun 2021 21:16:12 +0200
Subject: [PATCH] Add migration guide for 1.17

---
 guide/docs/migration/1_16_to_1_17.md | 27 +++++++++++++++++++++++++++
 guide/mkdocs.yml                     |  2 ++
 2 files changed, 29 insertions(+)
 create mode 100644 guide/docs/migration/1_16_to_1_17.md

diff --git a/guide/docs/migration/1_16_to_1_17.md b/guide/docs/migration/1_16_to_1_17.md
new file mode 100644
index 00000000..668bf17b
--- /dev/null
+++ b/guide/docs/migration/1_16_to_1_17.md
@@ -0,0 +1,27 @@
+# Updating from KSpigot for 1.16 to KSpigot for 1.17
+
+## Dependency management
+
+Do **not** use the Gradle shadow plugin anymore! Spigot now has its own library feature, use that one instead. This
+applies to KSpigot, but in the best case for your other dependencies as well!
+
+For KSpigot this means, that you have to add the following to your `plugin.yml`:
+
+```yaml
+libraries:
+  - "net.axay:kspigot:VERSION"
+```
+
+Of course, replace `VERSION` with the KSpigot version you are using.
+
+Read the setup guide for more information.
+
+## Removed features
+
+You can no longer await anvil input from a player. This feature was not stable enough to fit in this project.
+
+## Changed
+
+The `Listener.register()` extension function now is no longer available, instead it has been replaced
+by `SingleListener<T : Event>.register()`. Don't worry, this means that this change does not affect you if you are using
+the `listen` function provided by KSpigot.
diff --git a/guide/mkdocs.yml b/guide/mkdocs.yml
index 803476d5..01e2ac18 100644
--- a/guide/mkdocs.yml
+++ b/guide/mkdocs.yml
@@ -40,3 +40,5 @@ nav:
       - Item builder: extensions/itembuilder.md
   - Gui:
       - Compounds: gui/compounds.md
+  - Migration:
+      - "1.16 -> 1.17": migration/1_16_to_1_17.md