From 65f2a4feb400ac754f71a060a4cfff5b45fb13a8 Mon Sep 17 00:00:00 2001
From: K4ryuu <104531589+K4ryuu@users.noreply.github.com>
Date: Mon, 25 Mar 2024 13:52:04 +0100
Subject: [PATCH] Readme Update

---
 README.md | 30 +++++++++++++++++++-----------
 1 file changed, 19 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 31a08b6..1fc3ace 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,26 @@
 <a name="readme-top"></a>
 
-![GitHub tag (with filter)](https://img.shields.io/github/v/tag/KitsuneLab-Development/CS2_TemplateRepo?style=for-the-badge&label=Version)
-![GitHub Repo stars](https://img.shields.io/github/stars/KitsuneLab-Development/CS2_TemplateRepo?style=for-the-badge)
-![GitHub issues](https://img.shields.io/github/issues/KitsuneLab-Development/CS2_TemplateRepo?style=for-the-badge)
-![GitHub](https://img.shields.io/github/license/KitsuneLab-Development/CS2_TemplateRepo?style=for-the-badge)
-![GitHub all releases](https://img.shields.io/github/downloads/KitsuneLab-Development/CS2_TemplateRepo/total?style=for-the-badge)
-![GitHub last commit (branch)](https://img.shields.io/github/last-commit/KitsuneLab-Development/CS2_TemplateRepo/dev?style=for-the-badge)
+![GitHub tag (with filter)](https://img.shields.io/github/v/tag/K4ryuu/K4-System-MMRanks?style=for-the-badge&label=Version)
+![GitHub Repo stars](https://img.shields.io/github/stars/K4ryuu/K4-System-MMRanks?style=for-the-badge)
+![GitHub issues](https://img.shields.io/github/issues/K4ryuu/K4-System-MMRanks?style=for-the-badge)
+![GitHub](https://img.shields.io/github/license/K4ryuu/K4-System-MMRanks?style=for-the-badge)
+![GitHub all releases](https://img.shields.io/github/downloads/K4ryuu/K4-System-MMRanks/total?style=for-the-badge)
+![GitHub last commit (branch)](https://img.shields.io/github/last-commit/K4ryuu/K4-System-MMRanks/dev?style=for-the-badge)
 
 <!-- PROJECT LOGO -->
 <br />
 <div align="center">
   <h1 align="center">KitsuneLab©</h1>
-  <h3 align="center">PLACE OF TITLE</h3>
-  <a align="center">PLACE OF DESCRIPTION</a>
+  <h3 align="center">K4-System Matchmaking Ranks</h3>
+  <a align="center">This plugin is an addon for K4-System to enable scoreboard matchmaking ranks.</a>
 
   <p align="center">
     <br />
-    <a href="https://github.com/KitsuneLab-Development/CS2_TemplateRepo/releases">Download</a>
+    <a href="https://github.com/K4ryuu/K4-System-MMRanks/releases">Download</a>
     ·
-    <a href="https://github.com/KitsuneLab-Development/CS2_TemplateRepo/issues/new?assignees=KitsuneLab-Development&labels=bug&projects=&template=bug_report.md&title=%5BBUG%5D">Report Bug</a>
+    <a href="https://github.com/K4ryuu/K4-System-MMRanks/issues/new?assignees=KitsuneLab-Development&labels=bug&projects=&template=bug_report.md&title=%5BBUG%5D">Report Bug</a>
     ·
-    <a href="https://github.com/KitsuneLab-Development/CS2_TemplateRepo/issues/new?assignees=KitsuneLab-Development&labels=enhancement&projects=&template=feature_request.md&title=%5BREQ%5D">Request Feature</a>
+    <a href="https://github.com/K4ryuu/K4-System-MMRanks/issues/new?assignees=KitsuneLab-Development&labels=enhancement&projects=&template=feature_request.md&title=%5BREQ%5D">Request Feature</a>
   </p>
 </div>
 
@@ -36,6 +36,14 @@ To use this server addon, you'll need the following dependencies installed:
 
 <!-- ROADMAP -->
 
+## Modes
+
+- 0 - Disabled
+- 1 - Prime Points
+- 2 - Rank Images
+
+<!-- ROADMAP -->
+
 ## Roadmap
 
 - [ ] No plans for now