From c415649b17e4a7d8606e4b34a030499661dc0e67 Mon Sep 17 00:00:00 2001
From: Tanguy Herbron <tanguy.herbron@outlook.com>
Date: Fri, 30 Apr 2021 14:40:07 +0200
Subject: [PATCH] Initialise repository with appropriate README

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5898763
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# SNIR's minecraft server
+## Usage
+Game server for the Minecraft game. It includes configurations for server optimization and quality of life. The repository also contains the map, which can be downloaded separately and used independently.
+
+## Requirements
+Do deploy this instance, you only need to install `docker-compose` and `docker`.
+
+## Installation
+To deploy a copy of this instance, you might want to modify where the volumes are pointing to.
+Then run
+
+```
+docker-compose up -d
+```
+
+All necessary images should be downloaded automatically and the service should be started in the background.
+
+## Minecraft update
+When an update is release by Mojang, the `jar` file must be updated and further configuration might be necessary to keep server optimization and quality of life improvements.