Skip to content

Commit

Permalink
Fleshes out readme with more
Browse files Browse the repository at this point in the history
  • Loading branch information
Evan Cobb committed Jul 28, 2024
1 parent 5ad59cc commit e6d526b
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -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.

0 comments on commit e6d526b

Please sign in to comment.