Skip to content

Commit 7a52bfe

Browse files
committed
Improve README
1 parent 21a8b6a commit 7a52bfe

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,15 @@
55
[![Discord](https://img.shields.io/static/v1?style=popout&label=chat&message=discord&color=7289DA)](https://discord.gg/eXcffmW)
66

77
Adds break progress to WAILA.
8+
9+
Break Progress requires the [Fabric modloader](https://fabricmc.net/use/), [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api), and [HWYLA](https://www.curseforge.com/minecraft/mc-mods/hwyla).
10+
11+
## Installation
12+
13+
1. Install [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api) and [HWYLA](https://www.curseforge.com/minecraft/mc-mods/hwyla) if they are not installed.
14+
2. Download Break Progress from [CurseForge](https://www.curseforge.com/minecraft/mc-mods/break-progress/files) or [GitHub](https://github.com/haykam821/Break-Progress/releases).
15+
3. Place the downloaded file in your `mods` folder.
16+
17+
## Usage
18+
19+
When this mod is installed, a tooltip line indicating the break progress as a percentage will appear in the WAILA overlay. This line only appears when a block is actively being broken. Therefore, the line will not display for unbreakable blocks such as bedrock.

0 commit comments

Comments
 (0)