From 1d8b51dcfbe75a43ef08c7d843c8a95480f3cd6e Mon Sep 17 00:00:00 2001 From: Vincent Date: Thu, 29 Aug 2024 22:28:43 +0100 Subject: [PATCH] docs: update README.md --- README.md | 47 +++++++++++++++++++++++++++++++++++------------ 1 file changed, 35 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2fada689b..c14ae46a2 100644 --- a/README.md +++ b/README.md @@ -83,31 +83,54 @@ endstone ### 🐧 Linux -Endstone on linux can be installed using an autoinstaller script -Operating systems supported by the autoinstaller (not distros of them) are: +Endstone can be easily installed on Linux using an autoinstaller script. + +#### Supported Operating Systems + +The autoinstaller supports the following operating systems (note: these are the OSes, not their derivatives): + - Ubuntu - Debian - Fedora -- Arch +- Arch Linux + +#### Download the Installer + +You can use either `wget` or `curl` to download the required scripts. + +**Using `wget`:** -install using wget ```shell -wget https://raw.githubusercontent.com/legitbox/endstone/main/autoinstall.sh -sudo chmod +x autoinstall.sh -wget https://raw.githubusercontent.com/legitbox/endstone/main/start.sh +wget https://raw.githubusercontent.com/EndstoneMC/endstone/main/scripts/autoinstall.sh sudo chmod +x autoinstall.sh -./autoinstall.sh +wget https://raw.githubusercontent.com/EndstoneMC/endstone/main/scripts/start.sh +sudo chmod +x start.sh ``` -install using curl +**Using `curl`:** + ```shell -curl -O https://raw.githubusercontent.com/legitbox/endstone/main/autoinstall.sh -sudo chmod +x autoinstall.sh -curl -O https://raw.githubusercontent.com/legitbox/endstone/main/start.sh +curl -O https://raw.githubusercontent.com/EndstoneMC/endstone/main/scripts/autoinstall.sh sudo chmod +x autoinstall.sh +curl -O https://raw.githubusercontent.com/EndstoneMC/endstone/main/scripts/start.sh +sudo chmod +x start.sh +``` + +#### Install and Start Endstone + +Once the download is complete, run the following command to install Endstone: + +```shell ./autoinstall.sh ``` +This will install Endstone and automatically start the server after installation. + +If you want to start Endstone at any time, simply run: + +```shell +./start.sh +``` ### 🐳 Docker