diff --git a/README.md b/README.md index 1820992..c61bde0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ # Progression +[![CI](https://github.com/viral32111/progression/actions/workflows/ci.yml/badge.svg)](https://github.com/viral32111/progression/actions/workflows/ci.yml) +[![CodeQL](https://github.com/viral32111/progression/actions/workflows/codeql.yml/badge.svg)](https://github.com/viral32111/progression/actions/workflows/codeql.yml) +![GitHub tag (with filter)](https://img.shields.io/github/v/tag/viral32111/progression?label=Latest) +![GitHub repository size](https://img.shields.io/github/repo-size/viral32111/progression?label=Size) +![GitHub release downloads](https://img.shields.io/github/downloads/viral32111/progression/total?label=Downloads) +![GitHub commit activity](https://img.shields.io/github/commit-activity/m/viral32111/progression?label=Commits) + This is a [Minecraft Fabric](https://fabricmc.net/) mod that limits player progression to other dimensions until global player experience thresholds are met. Thank you to [Toothfull](https://github.com/toothfull) for the idea. -## Usage +## 📥 Usage + +Requires Fabric API +Requires Fabric Language Kotlin +
1. Download the mod file (`.jar`) from [the latest release](https://github.com/viral32111/progression/releases/latest). 2. Place the mod file in the server's `mods` directory. @@ -12,7 +23,7 @@ Thank you to [Toothfull](https://github.com/toothfull) for the idea. 3. Configure appropriately in the `config/viral32111/progression.json` file. 4. Restart the server. -## License +## ⚖️ License Copyright (C) 2023 [viral32111](https://viral32111.com).