Skip to content

docs: refresh README to reflect current addon state (#45)#46

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

docs: refresh README to reflect current addon state (#45)#46
Xerrion merged 1 commit intomasterfrom
docs/45-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. No source code changes.

Type of Change

  • Documentation update

Related Issues

Closes #45

Testing

  • Luacheck passes (luacheck .) - no Lua changes
  • All claims verified against current source on master (TOC, listener files, slash dispatcher, event registration, defaults)
  • Tested in-game manually - N/A, docs only
  • WoW version(s) tested on: N/A (documentation only)

Changes

  • Removed all Cataclysm Classic references (no Interface-Cata in TOC, no Core_Cata.lua exists)
  • Fixed Supported Versions table to match the current TOC and actual listener filenames at the repo root
  • Corrected the Configuration scope claim from per-character to account-wide (matches ## SavedVariables: RaidLogAutoDB)
  • Added the 5-second M+ post-completion grace period to How It Works
  • Added a new Events Handled table covering the 5 registered events
  • Added a Dependencies note highlighting zero external libraries (no Ace3, no LibStub)
  • Added Wago.io badge and link
  • License link uses master branch

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

Removes fabricated Cataclysm Classic support, fixes Supported Versions table to match the TOC and actual listener filenames, corrects the Configuration scope claim from per-character to account-wide, adds the 5-second M+ post-completion grace period to How It Works, adds a new Events Handled table, and highlights the zero-external-dependencies design.

Closes #45
@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 54 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8011d08d-4fdb-45f8-bbea-cf9f19ec09b3

📥 Commits

Reviewing files that changed from the base of the PR and between c38749b and 50cd820.

📒 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 54 minutes and 41 seconds.

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

@Xerrion Xerrion merged commit 52c5afd into master Apr 29, 2026
3 checks passed
@Xerrion Xerrion deleted the docs/45-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.

[Docs]: Refresh README to reflect current addon state

1 participant