Update README.md

This commit is contained in:
totalllyswede
2025-11-20 19:43:25 -08:00
committed by GitHub
parent 6d4e34cb45
commit 1f65ea1695
+25
View File
@@ -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!