From 04e0f3c2299258e0ba609454263ded49841705b2 Mon Sep 17 00:00:00 2001
From: slimDebug <66317138+slimDebug@users.noreply.github.com>
Date: Wed, 11 May 2022 15:39:50 +0200
Subject: [PATCH] Update README.md

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 93f80c2..5c8dd86 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,27 @@
-HuntMmrReader
\ No newline at end of file
+# Hunt MMR Reader
+## What is this?
+I made this tool for the game **Hunt: Showdown**. In this game you have some kind of rank that is represented by stars. The ranking goes from 1 to 6 stars, where 1 is the lowest and 6 is the best. These stars are bound to a number.\
+The specific rank ranges are as follows:
+| MMR range | Stars |
+|:---------:|:-----:|
+|   0-1999  |   ★   |
+| 2000-2299 |   ★★   |
+| 2300-2599 |   ★★★   |
+| 2600-2749 |   ★★★★   |
+| 2750-2999 |   ★★★★★   |
+| >= 3000   |   ★★★★★★   |\
+## How do I use this program?
+1. Download the [newest release version](https://github.com/slimDebug/HuntMmrReader/releases/latest) of the unt MMR Reader. 
+2. Extract the zip whereever you like. 
+3. Open the **_HuntMmrReader.exe_** file.
+4. Click _Settings_ in the menu tab and click _Edit Path..._.![grafik](https://user-images.githubusercontent.com/66317138/167859972-eeff99ab-2166-4906-9480-7f4ae567e862.png)
+
+5. Select the _attributes.xml_ file from your **Hunt: Showdown** installation folder. The file should be located in **_SteamLibrary\steamapps\common\Hunt Showdown\user\profiles\default\attributes.xml_**
+6. Hit the open button.
+7. You should see something like this:![grafik](https://user-images.githubusercontent.com/66317138/167861050-40446d3a-2315-4b10-84cb-2e5c31bc499e.png)
+8. Congratulations. You can see the MMR of all teams/players of your most recent match.
+## To be noted
+- The program automatically detects if the file was modified and reads it on changes.
+- Hitting **F5** forces the program to read the file.
+## Can I get VAC ban or game ban for using this?
+This program just reads a file. You can achieve the same with any text editor. I would say it's very unlikely to get banned for this, but at the end it is up to the **Hunt: Showdown developers** to decide who should get banned. **I'm not liable for any damage caused by this software and I'm not guaranteeing anything. In the end it is up to you and it's your risk to use this software.**