README Improvements + Workflow Fix

.github/workflows/build.yml

@@ -0,0 +1,40 @@
+# Automatically build the project and run any configured tests for every push
+# and submitted pull request. This can help catch issues that only occur on
+# certain platforms or Java versions, and provides a first line of defence
+# against bad commits.
+
+name: build
+on: [pull_request, push]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        # Use these Java versions
+        java: [
+          21,    # Current Java LTS
+        ]
+        # and run on both Linux and Windows
+        os: [ubuntu-22.04, windows-2022]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+      - name: validate gradle wrapper
+        uses: gradle/wrapper-validation-action@v1
+      - name: setup jdk ${{ matrix.java }}
+        uses: actions/setup-java@v4
+        with:
+          java-version: ${{ matrix.java }}
+          distribution: 'microsoft'
+      - name: make gradle wrapper executable
+        if: ${{ runner.os != 'Windows' }}
+        run: chmod +x ./gradlew
+      - name: build
+        run: ./gradlew build
+      - name: capture build artifacts
+        if: ${{ runner.os == 'Linux' && matrix.java == '21' }} # Only upload artifacts built from latest java on one OS
+        uses: actions/upload-artifact@v4
+        with:
+            name: Artifacts
+            path: build/libs/

README.md

@@ -1,22 +1,49 @@
-# Accurate Block Placement Reborn
-[Modrinth Page](https://modrinth.com/mod/accurate-block-placement-reborn)
+<h1 align="center">Accurate Block Placement: Reborn</h1>
 
-[CurseForge Page](https://www.curseforge.com/minecraft/mc-mods/accurate-block-placement-reborn)
+<p align="center">
+<a href="https://modrinth.com/mod/accurate-block-placement-reborn">
+<img alt="Current Modrinth Release" src="https://img.shields.io/modrinth/v/kzwxhsjp?style=for-the-badge&logo=modrinth"/>
+</a>
+<a href="https://www.curseforge.com/minecraft/mc-mods/accurate-block-placement-reborn">
+<img alt="Current CurseForge Release" src="https://img.shields.io/curseforge/v/886719?style=for-the-badge&logo=curseforge"/>
+</a>
+<a href="https://github.com/hschwar/AccurateBlockPlacement-Reborn/releases">
+<img alt="Current GitHub Release" src="https://img.shields.io/github/v/release/hschwar/AccurateBlockPlacement-Reborn?label=VERSION&style=for-the-badge&logo=github"/>
+</a>
+<br/><br/>
+<a>
+<img alt="Modrinth Downloads" src="https://img.shields.io/modrinth/dt/kzwxhsjp?style=for-the-badge&logo=modrinth"/>
+</a>
+<a>
+<img alt="CurseForge Downloads" src="https://img.shields.io/curseforge/dt/886719?style=for-the-badge&logo=curseforge"/>
+</a>
+<br/><br/>
+</p>
 
-This fork adds support for versions 1.19-1.21.3
+AccurateBlockPlacement: Reborn is a client-side mod for [Fabric](https://fabricmc.net).
 
-The version numbers are continuing from the original [Accurate Block Placement](https://www.curseforge.com/minecraft/mc-mods/accurate-block-placement) mod.
+[Fabric API](https://modrinth.com/mod/fabric-api) is required, [Mod Menu](https://modrinth.com/mod/modmenu) and [Cloth Config API](https://modrinth.com/mod/cloth-config) are optional, but strongly recommended.
 
-This is a client side mod made for [Fabric](https://fabricmc.net), but it also works with [Quilt](https://quiltmc.org). 
-[Fabric API](https://modrinth.com/mod/fabric-api) is required, [Mod Menu](https://modrinth.com/mod/modmenu) and [Cloth Config API](https://modrinth.com/mod/cloth-config) are optional.
+---
 
-**[WARNING]** This mod could get you banned on some servers with anti-cheats!
->This includes (but is not whatsoever limited to) Hypixel & most competitive servers.
+*Although many experienced minecraft players know exactly how to time their clicks in order to rapidly place blocks with no mistakes, why should it be that difficult? In this mod, if you hold your 'use key' (usually RMB) and look at a new block it will automatically place it no matter how fast you move. No more need to time when you click or look in order to accurately place blocks quickly!*
 
-In vanilla Minecraft, if you hold right-click with blocks, the game will place a block every 4 ticks. This means that if you try to place a row of blocks, you might miss some blocks or place too many. This mod fixes both problems, as seen in the GIF below.
+## Features
+**WARNING:** This mod may be considered a "cheat" on some servers (and detected as so)! Please check the server's rules before using this mod. _Use this at your own risk._
 
-You can set a keybind to toggle this mod on or off.
-![Mod Showcase](https://cdn-raw.modrinth.com/data/kzwxhsjp/images/94a4de623aca8c5afdc07edca76ed663127d93b2.gif)
+### Accurate Block Placement
+Accurate Block Placement makes placing blocks a smooth and reliable process when holding right click. The best way to explain it is the following GIF:
 
-**NOTE:**
-This mod is not to be confused with the [Tweakeroo](https://www.curseforge.com/minecraft/mc-mods/tweakeroo)/[Carpet](https://modrinth.com/mod/carpet) feature of the same name, which is a completely different thing. 
+<img alt="Mod Showcase" src="https://cdn-raw.modrinth.com/data/kzwxhsjp/images/94a4de623aca8c5afdc07edca76ed663127d93b2.gif" width="512" height="288" />
+
+Enabled by default, can be toggled on or off through the config or by way of a configurable keybind (default: Not Bound).
+
+### Fast Block Breaking (v1.3.0+ for 1.21.3+)
+Fast Block Breaking makes breaking blocks much easier and more consistent, by removing the Mining Cooldown when breaking blocks.
+
+No GIF for this one yet :(, _essentially haste insta-mining but for creative mode_
+
+Disabled by default, can be toggled on or off through the config or by way of a configurable keybind (default: Not Bound).
+
+## License
+Accurate Block Placement: Reborn is provided under the [MIT License](https://github.com/hschwar/AccurateBlockPlacement-Reborn/blob/main/LICENSE).