Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sipsuru authored Nov 11, 2024
1 parent 186fb14 commit acb02eb
Showing 1 changed file with 81 additions and 0 deletions.
81 changes: 81 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit acb02eb

Please sign in to comment.