From 4661368e150173895e1ee3b36ff7a9251b9b313b Mon Sep 17 00:00:00 2001
From: Alexander <protonull@protonmail.com>
Date: Mon, 19 Aug 2024 23:46:48 +0100
Subject: [PATCH] Update README

Relocates the README and its screenshot to the .github folder to declutter the root folder.
---
 .github/README.md                             |  34 ++++++++++++++++++
 .../assets/screenshot.png                     | Bin
 README.md                                     |  19 ----------
 3 files changed, 34 insertions(+), 19 deletions(-)
 create mode 100644 .github/README.md
 rename screenshot.png => .github/assets/screenshot.png (100%)
 delete mode 100644 README.md

diff --git a/.github/README.md b/.github/README.md
new file mode 100644
index 0000000..770a6f7
--- /dev/null
+++ b/.github/README.md
@@ -0,0 +1,34 @@
+# CivModern
+
+## Features
+
+- Compacted items will have a configurably-coloured stack count.
+
+- Combat radar that displays players displays nearby players, boats, minecarts, and items.
+
+- Ice-road macro (bound to `BACKSPACE` by default).
+
+- Auto-attack macro (bound to `0` by default).
+
+- Hold-key macro for the left mouse button (bound to `-` by default).
+
+- Hold-key macro for the right mouse button (bound to `=` by default).
+
+You may open CivModern's configuration screen in-game with the `R` binding. Or you can modify the config file directly,
+which is located at `.minecraft/config/civmodern.properties`.
+
+![The radar configuration screen](./assets/screenshot.png)
+
+## Requirements
+
+| Fabric                                                                         | Forge                                    |
+|--------------------------------------------------------------------------------|------------------------------------------|
+| Fabric Loader: `0.15.11` (or newer)                                            | Forge Loader: `1.20.6-50.1.0` (or newer) |
+| [Fabric API](https://modrinth.com/mod/fabric-api): `0.100.8+1.20.6` (or newer) |                                          |
+
+
+## Recommendations
+
+| Fabric                                                           |
+|------------------------------------------------------------------|
+| [ModMenu](https://modrinth.com/mod/modmenu): `10.0.0` (or newer) |
diff --git a/screenshot.png b/.github/assets/screenshot.png
similarity index 100%
rename from screenshot.png
rename to .github/assets/screenshot.png
diff --git a/README.md b/README.md
deleted file mode 100644
index ec5e211..0000000
--- a/README.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# CivModern
-
-## Features
-
-CivModern features radar, a macro to hold left (bound to `-`) or right click (bound to `=`), a macro for auto attacking (bound to `0`), and a macro for travelling down ice roads (bound to backspace).
-It highlights compacted items, making them easier to spot at a glance.
-These features can be configured in game by pressing R.
-The controls can also be modified in your controls screen.
-
-![The radar configuration screen](screenshot.png)
-
-## Installation instructions
-
-CivModern supports both the Forge and Fabric modloaders on 1.18.2
-Download the version for your modloader at [Releases](https://github.com/okx-code/civmodern/releases/latest).
-
-The Fabric version requires Fabric API.
-
-The mod's configuration file can be found at `MINECRAFT/config/civmodern.properties` where `MINECRAFT` is your Minecraft instance's installation directory.