From 682b85fd90b8ef89b8a5a4eafa90163f15a5d34e Mon Sep 17 00:00:00 2001
From: Sergei Solovev <31823239+SeAnSolovev@users.noreply.github.com>
Date: Sun, 18 Aug 2024 01:18:42 +0300
Subject: [PATCH] Update README.md (#40)

---
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 54 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index eb9da4e..b906e09 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,55 @@
-<p align="center"><b>Automatic installation for EngineGP</p>
-Supported systems:</br>
-GNU/Linux: Debian 11, 12</br>
-GNU/Linux: Ubuntu 22.04, 24.04</br>
-</br>
-Starting the auto installer:</br>
-apt -y install git</br>
-git clone https://github.com/EngineGPDev/Autoinstall.git</br>
-chmod +x ./Autoinstall/install.sh</br>
+## Automatic installation for EngineGP
+**This shell script allows you to:**
+- Install EngineGP in automatic mode;
+- Set up a location (unit);
+- Download game servers.
+## Supported systems:
+- **GNU/Linux:** Debian 11, 12
+- **GNU/Linux:** Ubuntu 22.04, 24.04
+> [!IMPORTANT]
+> The architecture and bit depth of x86_64 are required
+## Starting the auto installer:
+- **Update indexes and packages**
+```bash
+apt -y update && apt -y upgrade
+```
+- **Install GIT**
+```bash
+apt -y install git
+```
+- **Clone the repository**
+```bash
+git clone https://github.com/EngineGPDev/Autoinstall.git
+```
+- **Make the installation file executable**
+```bash
+chmod +x ./Autoinstall/install.sh
+```
+- **Run automatic installation**
+```bash
 ./Autoinstall/install.sh
+```
+## Automatic installation keys:
+- **Forcibly specifying an IP address**
+```bash
+./Autoinstall/install.sh --ip 192.0.2.0
+```
+> [!NOTE]
+> Instead of 192.0.2.0, you need to substitute your IP address.
+
+- **Choosing the php version**
+```bash
+./Autoinstall/install.sh --php 7.4
+```
+> [!NOTE]
+> Instead of 7.4, you need to substitute the desired php version;
+> Supported php versions: 7.4, 8.0, 8.1, 8.2
+
+- **Selecting the working branch of the panel**
+```bash
+./Autoinstall/install.sh --branch main
+```
+> [!NOTE]
+> main - the current stable version;
+> beta - current beta version;
+> develop - future beta version.