readme and icon

README.md

@@ -1,9 +1,61 @@
-# Fabric Example Mod
+# Controlify Wynn
 
-## Setup
+> Have you ever wondered what it would be like to play Wynncraft with a controller?
 
-For setup instructions please see the [fabric wiki page](https://fabricmc.net/wiki/tutorial:setup) that relates to the IDE that you are using.
+Controllify Wynn aims to make it easy to play Wynncraft with a controller.
+It not only adds [Controlify](https://modrinth.com/mod/controlify) compatability to [Wynntils](https://modrinth.com/mod/wynntils), but also adds some other nice-to-haves such as additional keybinds (such as a quick Blacksmith sell or Identify) and visual guides (such as the Gathering keybind guide).
+
+## Full Feature List
+
+- Controlify/Wynntils compatability:
+  - Allow binding Wynntils keybinds with Controlify
+  - Enable better Wynntils GUI navigation with controllers
+- New keybinds to help with controller usage:
+  - Identify/Sell/Scrap Items (inside Identifer/Blacksmith GUI) - GUI Abstract Action 1
+  - Page/Scroll Navigation (inside Trade Market/Bank/Ability Tree/Default Quest Book)
+- Contoller gathering button guide
+
+## Mod Dependencies/Requirements
+
+- Minecraft: `1.20.2` (Required for Wynntils)
+- [Fabric API](https://modrinth.com/mod/fabric-api)
+- [Wynntils](https://modrinth.com/mod/wynntils)
+- [Controlify](https://modrinth.com/mod/controlify)
+
+## Suggested Configuration
+
+Through playing Wynncraft with an Xbox controller, this is the configuration that works for me (and is by no means a requrement, you do you!).
+
+- Movement: Controlify defaults
+- Gameplay:
+  - Drop Item/Stack: Unbound
+  - Change Perspective: Unbound
+  - Pick Block: Unbound
+- Inventory:
+  - Drop Item: Unbound
+  - Swap Hands: Unbound
+- Miscellaneous: Controlify defaults
+- GUI: Controlify defaults
+- Radial Menu:
+  - Binds:
+    - Drop Item
+    - Open Quest Book
+    - Toggle Gammabright
+    - Open Main Menu
+    - Open Main Map
+    - Cast Spells/Custom Keybinds
+- Virtual Mouse:
+  - Toggle Virtual Mouse: Unbound
+- Wynntils:
+  - Mount Horse: DPad Left
+  - Cast 1st Spell: X
+  - Open Main Map: Share Button
+
+## WIP/Upcomming Features
+
+- Improved Wynntils GUI navigation
+- Imporved Wynncraft GUI navigation and usage
 
 ## License
 
-This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.
+Controlify Wynn is licensed under the license GNU Lesser General Public License v3.0