Skip to content

Commit 9c92cf8

Browse files
committed
Add documentation: README.md + changelog.md
1 parent 8724a8e commit 9c92cf8

3 files changed

Lines changed: 42 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# jButtonFlash
2+
3+
### [Download Latest](https://github.com/fondlez/jButtonFlash/releases/latest)
4+
5+
This is a backport of the jButtonFlash addon from the Legion game version. It
6+
supports the final version clients for Warlords of Draenor (WoD 6.2.4), Mists
7+
of Pandaria (MoP 5.4.8), Cataclysm (Cata 4.3.4) and Wrath of the Lich King
8+
(WotLK 3.3.5a).
9+
10+
* This backport is by [fondlez](https://github.com/fondlez/jButtonFlash).
11+
* Original addon is by [jwldnr](https://github.com/woldner/jButtonFlash).
12+
13+
## Description
14+
This simple addon adds an animation to highlight a button on the action bar when
15+
pressed.
16+
17+
It is inspired by the old and outdated addon "SnowFallKeyPress", which
18+
was made mostly obsolete when the Cataclysm expansion was launched due to the
19+
new Interface Combat option called "Cast action keybinds on key down". However,
20+
the remaining function that highlighted buttons on keypress was missed by many.
21+
This addon returns that feature in a similar way.
22+
23+
## Example Screenshot
24+
25+
![Example screenshot](doc/img/addon-jbuttonflash-1.0.0.jpg)

changelog.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Changelog for "jButtonFlash"
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.0] - 2025-01-07
9+
10+
Initial upload.
11+
12+
### Added
13+
- README.md
14+
- changelog.md
15+
16+
### Changed
17+
- backported addon to game client versions for WoD, MoP, Cata and WotLK.
22.4 KB
Loading

0 commit comments

Comments
 (0)