From 83a797410a27ad4478784183b35c705b0fa00c63 Mon Sep 17 00:00:00 2001
From: ShivamB25 <104637569+ShivamB25@users.noreply.github.com>
Date: Wed, 11 Oct 2023 03:54:03 +0530
Subject: [PATCH] Update README.md

---
 README.md | 60 +++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 38 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index 9b81713..6d66edb 100644
--- a/README.md
+++ b/README.md
@@ -14,17 +14,22 @@ Detection is based on various scene releases, if none are detected, it will defa
 ## Finished Result Example:
 ![image](https://user-images.githubusercontent.com/8385256/152403016-90660098-0b04-4178-babd-87e56ff1b390.png)
 
-## Instructions
-1. Run ```git clone https://github.com/zachstultz/komga-cover-extractor.git``` or download the repository up above.
-2. Run ```pip3 install -r requirements.txt```
-3. (OPTIONAL) (IGNORE IF ALL YOU INTEND TO USE IS COVER EXTRACTION) (ONLY REQUIRED FOR OPT RAR FEATURES)
-    - Install unrar 
-      - Linux: ```sudo apt-get install unrar```
-      - MacOS: ```brew install rar``` (requires [brew](https://brew.sh/)) (untested)
-      - Windows: Install UnRAR.dll from https://www.rarlab.com/rar_add.htm (untested)
-4. Read usage below and enjoy!
+## Installation
+To use the Komga Cover Extractor, you have several options:
+
+1. **Docker (Recommended):** You can use the [Docker image available here](https://hub.docker.com/r/zachstultz/komga-cover-extractor), which simplifies the setup process.
+
+2. **Manual Installation:** If you prefer manual installation, follow these steps:
+   1. Clone the repository: `git clone https://github.com/zachstultz/komga-cover-extractor.git`
+   2. Install required Python packages: `pip3 install -r requirements.txt`
+   3. (OPTIONAL) If you intend to use advanced RAR features, you may need to install unrar:
+      - Linux: `sudo apt-get install unrar`
+      - MacOS: `brew install rar` (requires [brew](https://brew.sh/)) (untested)
+      - Windows: Install UnRAR.dll from [rarlab.com](https://www.rarlab.com/rar_add.htm) (untested)
 
 ## Usage
+The Komga Cover Extractor provides several options for cover extraction. Here's how to use it:
+
 ```
 usage: komga_cover_extractor.py [-h] [-p [PATHS [PATHS ...]]] [-wh [WEBHOOK [WEBHOOK ...]]] [-c COMPRESS] [-cq COMPRESS_QUALITY]
 
@@ -35,23 +40,34 @@ optional arguments:
   -p [PATHS [PATHS ...]], --paths [PATHS [PATHS ...]]
                         The path/paths to be scanned for cover extraction.
   -wh [WEBHOOK [WEBHOOK ...]], --webhook [WEBHOOK [WEBHOOK ...]]
-                        The optional discord webhook url for notifications about changes and errors.
+                        The optional Discord webhook URL for notifications about changes and errors.
   -c COMPRESS, --compress COMPRESS
                         Whether or not to compress the extracted cover images.
   -cq COMPRESS_QUALITY, --compress_quality COMPRESS_QUALITY
                         The quality of the compressed cover images.
 ```
+
 ## Examples
-with compression :
-  
-  &nbsp;&nbsp;&nbsp;```python3 komga_cover_extractor.py -p "/path/to/manga" -p "/path/to/novels" -c "True" -cq "60"```
-
-without compression example:
-  
-  &nbsp;&nbsp;&nbsp;```python3 komga_cover_extractor.py -p "/path/to/manga" -p "/path/to/novels"```
-
-## Goals
-1. Transform script into manga/light novel manager with many features that includes cover extraction, but is not exclusive to it. ***(in-progress)***
-2. Modularize volume/chapter keyword regexes across the script. ***(in-progress)***
-3. Better documentation. ***(in-progress)***
+Here are a couple of usage examples:
+
+- **With Compression:**
+  ```
+  python3 komga_cover_extractor.py -p "/path/to/manga" -p "/path/to/novels" -c "True" -cq "60"
+  ```
+
+- **Without Compression:**
+  ```
+  python3 komga_cover_extractor.py -p "/path/to/manga" -p "/path/to/novels"
+  ```
+
+## Future Goals
+Our development team has ambitious plans for the Komga Cover Extractor, which include:
+
+1. Transforming the script into a comprehensive manga/light novel manager with a wide range of features that include cover extraction but are not limited to it (in-progress).
+2. Modularizing volume/chapter keyword regexes across the script (in-progress).
+3. Improving documentation to make the tool even more user-friendly (in-progress).
+
+For more information and updates, please refer to the [project's GitHub repository](https://github.com/zachstultz/komga-cover-extractor).
+
+Feel free to choose the installation method that suits your needs, and enjoy the benefits of using the Komga Cover Extractor!