Skip to content

Commit 2d3e542

Browse files
committed
chore: update README.md
1 parent f568e1d commit 2d3e542

1 file changed

Lines changed: 30 additions & 10 deletions

File tree

README.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,40 @@
1-
Aurora [![Build Status](https://travis-ci.org/Gethe/Aurora.svg?branch=master)](https://travis-ci.org/Gethe/Aurora)
1+
Aurora
22
======
33

4-
Currently
4+
Aurora is a Blizzard UI skinning addon focused on a clean, consistent visual style across default interface panels and frames.
55

6-
Aurora is an addon that restyles the default Blizzard interface to a clean, minimalistic theme that is consistent across the entire UI.
6+
It is maintained for current Retail WoW and can run standalone or embedded (for example inside RealUI_Skins).
77

8-
A lot of time has been spent on not only basic development and updates, but also refining and perfecting the appearance of each window and every frame.
8+
Information
9+
-----------
10+
11+
* Current development target is WoW 12.0.x.
12+
* Aurora includes a live Color Mode system with Normal, HDR, and accessibility presets.
13+
* Skinning updates prioritize taint-safe hooks and compatibility with Blizzard UI changes.
14+
15+
16+
Quick Start
17+
-----------
18+
19+
* Type `/aurora` to open options.
20+
* Use Appearance settings to switch Color Mode presets.
21+
* Type `/aurora status` to print runtime status details.
22+
23+
24+
Slash Commands
25+
--------------
926

10-
A single color that matches your current class or is a color of your choosing is used for highlights and emphasis.
27+
Aurora provides one base slash command with subcommands:
1128

12-
Options
13-
-------
29+
* `/aurora` - open configuration panel.
30+
* `/aurora help` - show available commands.
31+
* `/aurora status` - show configuration/compatibility/integration status.
32+
* `/aurora debug` - show debug output (requires LibTextDump).
33+
* `/aurora reset` - reset Aurora configuration to defaults.
1434

15-
Open the Aurora options from the in-game addon options, or type /aurora.
1635

17-
Bug reports
36+
Bug Reports
1837
-----------
1938

20-
Please report all issues on [GitHub](https://github.com/Gethe/Aurora).
39+
Please report issues on [GitHub](https://github.com/Gethe/Aurora).
40+
For support, discussion, and quick troubleshooting help, join the [RealUI Discord](https://discord.gg/sasExJYxgf).

0 commit comments

Comments
 (0)