Skip to content

docs: refresh README to reflect current addon state (#155)#156

Merged
Xerrion merged 1 commit intomasterfrom
docs/155-update-readme
Apr 29, 2026
Merged

docs: refresh README to reflect current addon state (#155)#156
Xerrion merged 1 commit intomasterfrom
docs/155-update-readme

Conversation

@Xerrion
Copy link
Copy Markdown
Owner

@Xerrion Xerrion commented Apr 29, 2026

Description

Refreshes README.md so it accurately reflects the addon as it sits on master. The previous README had drifted out of sync with the 0.7-0.13 releases (slash commands missing, supported versions wrong, no mention of the redesigned Options UI / ElvUI handling / DragonWidgets / direct loot history).

No source code changes - documentation only.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Refactor (non-breaking change that improves code quality)
  • Documentation update
  • Breaking change (fix or feature that would cause existing functionality to change)

Related Issues

Closes #155

Changes

  • Fixed Supported Versions table to match DragonLoot.toc exactly (Retail / TBC Anniversary / MoP Classic - no Cata)
  • Rebuilt slash-command table to include all 13 verbs (/dl enable, /dl disable, /dl testroll loop, /dl testroll stop, etc.) plus aliases
  • Rewrote Features section to cover the 0.7-0.13 additions (ElvUI conflict detection, redesigned tabbed Options UI, DragonWidgets, expanded appearance, direct loot history via CHAT_MSG_LOOT)
  • New Sub-addons section documenting DragonLoot + DragonLoot_Options (LoadOnDemand)
  • New ElvUI Compatibility section
  • New Localization section listing the 11 shipped locales
  • Expanded Contributing to mention just, mise, luacheck, busted, stylua
  • Fixed License link from main to master
  • Added CurseForge and Wago badges/links

Testing

  • Luacheck passes (luacheck .) - no source changes, but verified clean
  • Tested in-game manually - N/A, documentation only
  • WoW version(s) tested on: N/A - documentation only

All claims in the README were verified against current source on master:

  • Supported Versions table cross-checked against DragonLoot/DragonLoot.toc
  • Slash commands cross-checked against DragonLoot/Core/SlashCommands.lua
  • Features cross-checked against the 0.7-0.13 changelog and current source
  • Tables align; no em/en dashes
  • Links use master branch where applicable

Screenshots

N/A - documentation only.

Checklist

  • My code follows the project's code style (4-space indent, 120 char lines)
  • I have tested my changes in-game (N/A - docs only)
  • Luacheck reports no warnings
  • My commits follow conventional commit format

Updates Supported Versions table to match DragonLoot.toc, rebuilds the slash-command table to include all 13 verbs and aliases, rewrites Features for the 0.7-0.13 additions (ElvUI conflict detection, redesigned tabbed Options UI, DragonWidgets, expanded appearance, direct loot history). Adds new Sub-addons, ElvUI Compatibility, and Localization sections. Fixes the License link from main to master.

Closes #155
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 29, 2026

Warning

Rate limit exceeded

@Xerrion has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 41 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 8ae5e47f-0a6b-4fab-ba9c-f81d160216b9

📥 Commits

Reviewing files that changed from the base of the PR and between c337e94 and 11c2028.

📒 Files selected for processing (1)
  • README.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 2 minutes and 41 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

@Xerrion Xerrion merged commit 86bc315 into master Apr 29, 2026
3 checks passed
@Xerrion Xerrion deleted the docs/155-update-readme branch April 29, 2026 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Refresh README to reflect current addon state

1 participant