From 7c215d31772d5d44eb3d8b6be4342e3914041cb5 Mon Sep 17 00:00:00 2001
From: Andreas Greiner <andreasgreiner@online.de>
Date: Fri, 2 Feb 2024 20:04:46 +0100
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..53eb49e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# XCraft bot collection
+
+A collection of bots for the game XCraft, some being unfinished examples.
+
+## Download
+Download the latest version from [releases](https://git.greinet.com/EDV-Schule/XCraftBots/releases). It is a packed jar with all needed dependencies.
+
+## Usage
+Simply execute the jar using the following command to see the available bots:
+
+```
+java -jar XCraftBots-1.0-jar-with-dependencies.jar
+```
+```
+Please specify as parameter what you want to launch:
+  (1) XCastPlantFarm
+  (2) MarketplaceUI
+  (3) SwingUI2
+  (4) XCastHealthFarm
+  (5) XCastOkariFarm
+
+```
+Then select the wanted bot and specify it as parameter:
+```
+java -jar XCraftBots-1.0-jar-with-dependencies.jar 2
+```
\ No newline at end of file