Add README.md

.drone.yml

@@ -14,7 +14,7 @@ steps:
       base_url: https://git.greinet.com
       api_key:
         from_secret: gitea_api_key_xcraftbots
-      files: target/XCraftBots-1.0-jar-with-dependencies.jar
+      files: target/XCraftBots-*-jar-with-dependencies.jar
       checksum: sha256
       tag: ${DRONE_TAG}
     when:

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
+```