updated the readme

README.md

@@ -1 +1,27 @@
-Will be updated when the code is ready.
+# Smartphone Remote UE5
+
+*A Python middleman for the Smartphone Remote app, and Unreal Engine 5. This enables remote control of the camera in UE5 using a smartphone.*
+
+## Setup Instructions:
+
+1.] `git clone https://github.com/katznboyz1/smartphoneremote_ue5 %% cd smartphoneremote_ue5`
+
+2.] `python3 -m pip install -r requirements.txt`
+
+## CLI Args:
+
+`--bind` / `-b` : The port where the program will listen for incoming connections from the smartphone app. [Not required, default is 8096].
+
+`--generate-qr-code` / `-g` : Whether or not the program should generate a QR code that you can scan with your phone to connect to the middleman. [Not required, default is no].
+
+`--unreal-engine-api-root` / `-u` : The root point for the Unreal Engine web control API. [Not required, default is http://127.0.0.1:30010].
+
+`--unreal-engine-camera-path` / `-c` : The path for the camera in Unreal Engine. [Not required, however this will likely not work if you don't set it manually, as the default is specific to my debug environment].
+
+## Running the Program
+
+1.] Start Unreal Engine with the web control plugin enabled and configured.
+
+2.] `python3 smartphoneremote_ue5_reciever.py [args]`
+
+3.] Scan the QR code/enter the information on your phone to connect to the middleman.

smartphoneremote_ue5_reciever.py

@@ -31,7 +31,7 @@
     required = False,
     type = str,
     dest = 'recieverCLIArgs_unrealEngineAPIRoot',
-    help = '(http://a.d.d.r:port) the root point for the unrean engine web control api (default: http://127.0.0.1:30010)'
+    help = '(http://a.d.d.r:port) the root point for the unreal engine web control api (default: http://127.0.0.1:30010)'
 )
 recieverCLIParser.add_argument(
     '--unreal-engine-camera-path', '-c',