From 9d56f035f2984a8b1fc26417a1a197473a591bc8 Mon Sep 17 00:00:00 2001
From: TheTrouper <93684527+thetrouper@users.noreply.github.com>
Date: Thu, 9 May 2024 07:59:26 -0500
Subject: [PATCH] Updated README.md, as the mod is now public.

---
 README.md | 30 ++++++++++++++++++++++++------
 1 file changed, 24 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 90b04e9..d01d0f2 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,26 @@
-# Meteor Addon Template
+# Meteor Butler Addon
 
-A template to allow easy usage of the Meteor Addon API.
+Easily control multiple instances of meteor client through a single account.
 
-### How to use:  
-- Clone this project
-- Use this template to create new modules/commands
-- Run the mod with Meteor.
\ No newline at end of file
+### How to build:  
+- Make sure you have [Git](https://git-scm.com/download/win) installed
+  - If you're on linux, you can figure it out.
+- Clone into the repo and CD into it
+  - open a terminal 
+  - run `git clone https://github.com/thetrouper/Bulter && cd Butler`
+- Build the jar
+  - in the cloned directory, run `./gradlew build`
+  - If you are on linux, make sure to `chmod +x gradlew` or it wont run
+- The built jar should be in `build/libs/meteor-butler-<version>.jar`
+
+### Modules
+- Swarm Plus Worker
+  - Used to connect to the host and receive commands
+  - Verbose option will send what you receive from the server in your chat
+  - Currently, connections will appear to fail, but it still works fine. Please do not open an issue unless it throws an error, then actually doesn't work. The errors are not visible to the host.
+- Swarm Plus Host
+  - Used to host a server that can be connected to by the workers
+  - Verbose will display connection handshake packets
+### Commands
+- .manager
+  - View github wiki for usage guide