From 55e67d5384c3eb6e3b6556009d62d98fc279afa9 Mon Sep 17 00:00:00 2001
From: therungg <115251302+therungg@users.noreply.github.com>
Date: Fri, 7 Oct 2022 16:44:56 +0200
Subject: [PATCH] Create 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..7954f53
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# LiveSplit component for therun.gg
+
+This component does two things:
+
+1. After every reset, it uploads your LiveSplit .lss file to therun.gg. This will automatically sync your runs with the site. No more manual uploading needed. Also works with new runs that haven't been uploaded before to the site.
+2. After every split action, sends data about the current run only to therun.gg. This allows therun.gg to keep track of live runs.
+
+Right now, only the automatic upload is working. The data for the live runs gets transmitted, but I'm still working on the features on therun.gg itself to handle this data. Coming soon!
+
+## How to install
+
+1. Download the .dll file from the latest release https://github.com/therungg/LiveSplit.TheRun/releases/
+2. Insert the .dll file into your LiveSplit/Components directory and restart LiveSplit.
+3. Edit your LiveSplit Layout. Create a new Layout entry. The component should be under Information and is called therun.gg.
+4. Login to therun.gg and hover over your name in the top-right corner. Select Upload Key (or go here: https://therun.gg/upload-key). Copy the key from the clickable box.
+5. Back in LiveSplit, edit your Layout once again and select Layout Settings. On the "therun.gg" tab, insert your upload key. Select OK.
+
+That's it! From now on, when you use this layout, your runs will automatically be uploaded to therun.gg.
+
+## Upload Key
+
+Make sure to keep your Upload key secret! Anyone with this key can upload runs on your behalf.
+
+## Beta
+
+The Component is still in beta and being tested. If you find any bugs, please let me know at info@therun.gg or through our Discord at https://discord.gg/KuAwwPsKUp.