From 1f65ea1695c3014d42249f01cf2329c716a3327d Mon Sep 17 00:00:00 2001 From: totalllyswede Date: Thu, 20 Nov 2025 19:43:25 -0800 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index a948d2a..78e20a3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ # MiniMage_TWOW + MiniMage_TWOW is a lightweight World of Warcraft addon designed for Mages, providing quick access to portals and teleports via a convenient minimap button and dropdown menu. Perfect for both Horde and Alliance players, MiniMage_TWOW streamlines travel across Azeroth with just a click. + +## Features + +* **Minimap Button**: Drag and position a customizable minimap button for easy access. +* **Dropdown Menu**: Quick-cast portals and teleports, organized by faction. +* **Faction Support**: Automatically shows relevant portal and teleport spells for Horde or Alliance Mages. +* **Turtle WOW Portals Added**: Includes special portals unique to Turtle WOW. +* **Announcements**: Optional greetings and notifications in chat when the addon loads. + +## Installation + +1. Download or clone the repository into your `Interface/AddOns/` folder. +2. Ensure the folder structure is `MiniMage_TWOW/MiniMage.lua`. +3. Reload the UI or restart WoW. + +## Usage + +* Click the minimap button to open the dropdown menu. +* Select the desired portal or teleport. +* Only visible to Mages; hides automatically for other classes. + +## Contributing + +Feel free to fork, submit issues, or make pull requests. Suggestions for new portals or teleport locations are welcome!