From acb02eb58e8ef51a43192c784f0b43783b28d510 Mon Sep 17 00:00:00 2001
From: "Sipsuru (Dragon Patches)" <xxx.dev.dsf@gmail.com>
Date: Mon, 11 Nov 2024 09:03:18 +0530
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5b45da1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,81 @@
+<p align="center">
+  <img src="https://i.ibb.co/2hf5hd0/android-chrome-512x512-modified.png" alt="WPDL Logo" width="200px">
+</p>
+
+<h1 align="center">WP-Downloader Electron</h1>
+
+<p align="center">
+  Make everything so simple.
+  <br/><br/>
+  A minimal Electron application with JavaScript for <a href="https://github.com/MaximilianGT500/wp-downloader">WP Downloader</a> - Download WP stories for e-book readers, smartphones, desktop and more for free!
+  <br/><br/>
+</p>
+
+> [!NOTE]
+> This's a electron wrapper around [original source code](https://github.com/MaximilianGT500/wp-downloader) of WP-Downloader. So users don't need to install node.js, node-modules or run with cli.
+
+<br/>
+
+---
+
+> [!CAUTION]
+> The application cannot be used yet, cauing errors. Trying to fix soon as possible.
+
+<br/>
+
+- ## Just Use
+
+  - ### Downlod Binaries
+    You can download latest binaries from [GitHub releases]().
+
+> [!TIP]
+> You can also use hosted instance: https://wpdl.us (**Not** hosted by original owners)
+
+<br/>
+
+---
+
+> [!TIP]
+> For additional information on [wp-downloader](https://github.com/MaximilianGT500/wp-downloader) source code, visit [parent repo](https://github.com/MaximilianGT500/wp-downloader)
+
+<br/>
+
+- ## Build Status
+  - [![WPDL-Electron Build (Non Artifacts)](https://github.com/sipsuru/wp-downloader-electron/actions/workflows/build.yml/badge.svg)](https://github.com/sipsuru/wp-downloader-electron/actions/workflows/build.yml)
+  - [![WPDL-Electron Build Artifacts](https://github.com/sipsuru/wp-downloader-electron/actions/workflows/build-artifacts.yml/badge.svg)](https://github.com/sipsuru/wp-downloader-electron/actions/workflows/build-artifacts.yml)
+
+<br/>
+
+- ## Project Setup
+
+  - ### Install
+
+    ```bash
+    $ npm install
+    ```
+
+  - ### Development
+
+    ```bash
+    $ npm run dev
+    ```
+
+  - ### Build Unpack
+
+    ```bash
+    # For Running OS
+    $npm run build:unpack
+    ```
+
+  - ### Build
+
+    ```bash
+    # For Windows
+    $ npm run build:win
+
+    # For macOS 
+    $ npm run build:mac
+
+    # For Linux
+    $ npm run build:linux
+    ```