From ad8d7f696493a78d1161ea1b8869e3e7be4c8ff0 Mon Sep 17 00:00:00 2001
From: Ryuk <51106560+faroukbmiled@users.noreply.github.com>
Date: Mon, 31 Jul 2023 07:12:38 +0100
Subject: [PATCH] Update README.md

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8c62396..27d8400 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,18 @@
 # BOIIIWD
-BOIII GUI Workshop downloader
+- A GUI Workshop downloader meant for BO3 (boiii) build using PyQt5 <br>
+![image](https://github.com/faroukbmiled/BOIIIWD/assets/51106560/d8b68cc0-2d94-4d12-8f4c-0a11cc7616c5)
+
+## Pre Usage:
+- Place [SteamCMD](https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip) inside the same folder as the script and run it to do update and install
+  
+## Usage:
+- ```pip install -r requirements.txt```
+- ```python boiiiwd.py```
+
+## Compiling into an exe (pyinstaller):
+- ```pip install pyinstaller```
+- ```pyinstaller --noconfirm --onefile --windowed --name "BOIIIWD" --ascii  boiiiwd.py```
+  
+### Notes:
+. It saves your input except workshop id <br>
+. Excuse the progress bar its pretty shit atm