feat: Documentation 2.0

README.md

@@ -15,51 +15,131 @@
 <br>
 </div>
 
-# 💻 Morphe CLI
+<h1 align="center">Morphe Desktop</h1>
 
-Command-line application to use Morphe.
 
-&nbsp;
-## ❓ About
+## About
+Morphe Desktop is a command-line and a GUI application that uses [Morphe Patcher](https://github.com/MorpheApp/morphe-patcher) to patch Android apps.
 
-Morphe CLI is a command-line application that uses [Morphe Patcher](https://github.com/MorpheApp/morphe-patcher) to patch Android apps.
+Morphe Desktop's CLI is based on the prior work of [ReVanced](https://github.com/ReVanced/revanced-cli).
+The GUI is developed by the Morphe team.
+All modifications made by Morphe can be found in the Git history.
 
-Morphe CLI is based off the prior work of [ReVanced](https://github.com/ReVanced/revanced-cli).
-All modifications made by Morphe, along with their dates, can be found in the Git history.
 
-## 💪 Features
+## Prerequisites
+1. [Required] Java Runtime Environment 11 or above ([Azul Zulu JRE](https://www.azul.com/downloads/?version=java-11-lts&package=jre#zulu) or [OpenJDK](https://jdk.java.net/archive/)).
+2. [Required] Morphe Desktop jar file (morphe-desktop-*-all.jar). You can download the most recent stable version of Morphe Desktop from [here](https://github.com/MorpheApp/morphe-cli/releases/latest).
+3. [Required] Patches mpp file (patches-*.mpp). You can download the latest stable patch file from [here](https://github.com/MorpheApp/morphe-patches/releases/latest).
+4. [Required] Desired app file (app.apk). You can download your apk from [APK Mirror](https://www.apkmirror.com/).
+5. [Optional] [Android Debug Bridge (ADB)](https://developer.android.com/studio/command-line/adb) Only if you want to install the patched APK file on your device
 
-Some of the features Morphe CLI provides are:
+## Documentation
+Learn how to use Morphe Desktop by following the [documentation](/docs/documentation.md).
 
-- 💉 **Patch apps**: Harness Morphe Patcher to patch Android apps.
-- 💾 **Install and uninstall apps**: Install and uninstall Apps via ADB,
-  using the Android package manager or by mounting using root permissions.
-- 📃 **List patches from patch bundles**: List available patches, compatible packages, and versions.
-- 💪 **Flexibility and functionality**: Apply any combination of patches to any version of Android apps.
+## Getting Started
+Morphe Desktop is a powerful little application that allows you to patch and install(via ADB) android apps. Although sticking to the suggested apps is recommended, 
+you can try and experiment with other apps to your hearts content!
 
-## 🔽 Download
+Morphe Desktop runs in two modes:
+- CLI: You can run the CLI mode by directly calling it in your preferred terminal.
+- GUI: You can run the GUI mode by double-clicking the .jar file. This will open the Morphe Desktop window.
 
-You can download the most recent version of Morphe CLI from
-[here](https://github.com/MorpheApp/morphe-cli/releases/latest).  
-Learn how to use Morphe CLI by following the [documentation](/docs).
+While there are a lot of things that you can do and explore, for the time being in this section, we'll focus on running our first patching and getting a patched apk with the CLI and GUI.
 
-## 📚 Everything else
+> [!TIP]
+> If this your first time using Morphe Desktop, head over to the [GUI](#gui) section instead of [CLI](#cli). 
+> Once you get the hang of things, you can start tinkering with the CLI!
 
-### 📙 Contributing
+### First Run
 
-Thank you for considering contributing to Morphe CLI.
-You can find the contribution guidelines [here](CONTRIBUTING.md).
+#### CLI
+Following the [prerequisites](#prerequisites) section will get you the two basic but very required files for most patching:
+- morphe-desktop-*-all.jar file
+- patches-*.mpp
+
+Ideally place both of these files and your desired apk (preferably YouTube for your first run) file in the same folder for now to avoid path headaches.
+
+##### Steps:
+1. Open the terminal in the folder you have placed your files. If you are not in that folder, go there by:
+    ```
+    cd path/to/your/folder
+    ```
+
+2. Run the `ls` command if required to check the contents of the folder and confirm that you have all the files over there.
+
+3. Now run the patch command to instruct the morphe-desktop.jar to run the patching process by using the patch command on your apk file like this:
+    ```
+    java -jar morphe-desktop-*-all.jar patch -p patches-*.mpp your_app.apk
+    ```
+4. This should start the patching process. You should be able to see a bunch of patches being applied like such:
+    ```
+    INFO: Loading patches 
+    INFO: Decoding app manifest
+    INFO: Setting patch options
+    INFO: "Override certificate pinning" disabled
+    .
+    .
+    .
+    .
+    .
+    INFO: Aligning APK 
+    INFO: Signing APK
+    INFO: Saved to /your/path/your_app-patched.apk
+    ```
+
+> [!NOTE]
+> If you run into any issues or errors, please head over to the [documentation](/docs/documentation.md).
+
+
+
+5. You should now have a patched apk with the name of:
+    ```
+    your_app-patched.apk
+    ```
+Voilà! This is your final patched apk. Go ahead, install this apk on your device and try it out! 
+
+Now head over to the [documentation](/docs/documentation.md)
+
+#### GUI
+Unlike the CLI, the GUI is much user-friendly and straight forward to understand. If this is your first time, the GUI will open in simplified mode/ non-expert mode.
+
+
+##### Steps:
+1. Double-click on the downloaded morphe-desktop-*-all.jar. It should open like this:
 
-### 🛠️ Building
+![Morphe GUI Home Screen](docs/images/home_screen.png)
+
+2. All you need to do here drag and drop your apk/apkm into the application. Once done, click on the 'Patch' button to begin patching:
+
+![Morphe GUI App Selected](docs/images/app_selected.png)
+
+3. This should start the patching process and you should be able to see something like this:
+
+![Morphe GUI Patching](docs/images/patching.png)
+
+> [!NOTE]
+> If you run into any issues or errors, please head over to the [documentation](/docs/documentation.md).
+
+
+4. Once the patching is done, you will see the completed screen. You can now copy the apk over to your device and install it. If you happen to have ADB enabled, you can also directly install it via the application.
+
+![Morphe GUI Success](docs/images/success.png)
+
+Bravo! That should be your first successful patch. If you run into issues or want to tinker around more, please head to the [documentation](docs/documentation.md).
+
+
+[//]: # (## Everything else)
+## Contributing
+Thank you for considering contributing to Morphe Desktop.
+You can find the contribution guidelines [here](CONTRIBUTING.md).
 
-To build a Morphe CLI, you can follow the [documentation](/docs).
 
-### 📃 Documentation
+[//]: # (### Building)
 
-You can find the documentation of Morphe CLI [here](/docs).
+[//]: # (To build Morphe Desktop, you can follow the [documentation]&#40;/docs&#41;.)
 
-## 📜 License
 
+## License
 Morphe Patches are licensed under the [GNU General Public License v3.0](LICENSE), with additional conditions under GPLv3 Section 7:
 
 - **Name Restriction (7c):** The name **"Morphe"** may not be used for derivative works.