From e6d526b8042511c53d4e88bb64408d55783009b7 Mon Sep 17 00:00:00 2001 From: Evan Cobb <evan.cobb@pm.me> Date: Sat, 27 Jul 2024 19:55:17 -0500 Subject: [PATCH] Fleshes out readme with more --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d211d5..6c3d8d2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ Broker: Call to Arms ==================== -A Data Broker addon for showing you what dungeons/Looking For Raids will get you rewards right now. +A Data Broker addon for showing you what dungeons/Looking For Raids will get you rewards right now. This addon constantly checks the LFG panel for potential bonus loot for the roles you're capable of queuing for. + +It needs an LDB display addon to function. I recommend ChocolateBar. + +The broker data display shows how many Random Dungeons are offering a bonus reward for your role right now, as well as how many Looking For Raid instances offer a bonus reward for your role right now. Get it on [WoW Interface](https://wowinterface.com/downloads/info25623-BrokerCalltoArms), [Wago](https://addons.wago.io/addons/broker-call-to-arms), or use the [Cursebreaker tool](https://github.com/AcidWeb/CurseBreaker) (recommended) @@ -11,3 +15,11 @@ Get it on [WoW Interface](https://wowinterface.com/downloads/info25623-BrokerCal 1. Fork the repo 1. Make your changes in the fork 1. Submit a Pull Request back for review to this repo + +### Localization + +If you'd like to help localize the text here, simply follow the above steps and change the Localization.lua file to add your translations. Please submit an [issue on GitHub](https://github.com/icbat/broker-call-to-arms/issues) if you need any assistance with this workflow. + +### Releasing + +Release new versions by pushing a tag to the main branch of the form `v12345`. The GitHub action should take care of the rest.