From ec8874bfb3b8df55eb45a4cd4795be9cc741faee Mon Sep 17 00:00:00 2001
From: Miniontoby <tobias.gaarenstroom@gmail.com>
Date: Mon, 18 Apr 2022 13:25:03 +0200
Subject: [PATCH] Added README.md
---
README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 53 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aa2b12b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# Minecraft Server Status Handler
+
+A Handler for Lukasss93's PHP library to check Minecraft Servers Status
+
+
+# Installation
+
+To install you need to clone this repo first:
+
+```bash
+git clone https://edugit.org/Miniontoby/minecraft-server-status-handler.git
+cd minecraft-server-status-handler/
+```
+
+Then copy the `MCHandler.php`, `minecraft.css`, `pack.png` and `vendor/` to your website folder
+
+
+# Usage
+
+Add the minecraft.css stylesheet to your website in your head tag:
+
+```html
+<link rel="stylesheet" href="minecraft.css">
+```
+
+
+Then somewhere in your body tag where you want your server status add this:
+
+```php
+<?php
+include_once('MCHandler.php');
+echo MCHandler::HandleServers([
+ ['hostname' => 'play.cubecraft.com']
+]);
+?>
+```
+
+And if you now go to your website, you should be able to see the Cubecraft server status
+
+
+# Configuration
+
+For the `MCHandler::HandleServers` you need to supply settings.
+These settings are in an array inside an array, so you can do multiple servers at a time
+
+You can add the following parameters for each server:
+
+Parameter | Type | Default | Description
+----------|--------|-----------|-----------
+hostname | string | 127.0.0.1 | Server Hostname or IP address
+port | int | 25565 | Server port
+type | string | java | java or bedrock
+method | string | ping | ping or query
--
GitLab