From acc8c0ec72eb480e5869993171d024212e03b649 Mon Sep 17 00:00:00 2001
From: Radu Ursache <3800336+rursache@users.noreply.github.com>
Date: Wed, 24 Jan 2024 02:47:18 +0200
Subject: [PATCH] Create README.md

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4a0542b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# RSPS3Updater
+### Download PS3 Game Updates straight from Sony
+
+This is a simple python CLI app to download PS3 game updates at the highest speed and convinience. It was build so I could complete my offline collection of patches considering that the PS3 PSN will go down soon.
+
+## Installation
+You need Python and `requests` installed to run this CLI app.
+
+With python and PIP installed:
+```
+python -m pip install requests
+```
+
+## Usage
+Run `python .\main.py -h` to get the latest help
+
+```
+options:
+  -h, --help            show this help message and exit
+  -g GAMES, --games GAMES
+                        Title IDs for the PS3 games. Can be either 'BLES01807' (or comma-separated for batch
+                        downloads) or a path to a file containing one Title ID per line. Title IDs can contain dashes
+                        and parentheses
+  -d DOWNLOADPATH, -p DOWNLOADPATH, --downloadPath DOWNLOADPATH
+                        Path where the updates are downloaded. Defaults to './Updates'
+  -t THREADS, --threads THREADS
+                        Number of threads used for downloading. Between 1 and 32
+```
+
+## Example
+```
+RSPS3Updater.exe -g ./ids -d ./Updates -t 8
+```
+This will download all the updates for the game ids inside the `ids` file and save the `.pkg` files inside a `Updates` directory. Downloading will be done on `8 threads`
+
+## Building
+Install and use `pyinstaller` to obtain a binary:
+```
+pyinstaller --onefile .\main.py
+```
+
+## Thanks
+Thanks to [shinrax2](https://github.com/shinrax2) for his [PS3GameUpdateDownloader](https://github.com/shinrax2/PS3GameUpdateDownloader) that inspired me to create something faster and better for my needs