docs: improved readme structure and visuals

README.md

@@ -1,4 +1,4 @@
-![NeoDLP](./.github/banner.svg)
+![NeoDLP](./.github/images/banner.svg)
 
 # NeoDLP - (Neo Downloader Plus)
 
@@ -9,11 +9,12 @@ Cross-platform Video/Audio Downloader Desktop App with Modern UI and Browser Int
 [![github downloads](https://img.shields.io/github/downloads/neosubhamoy/neodlp/total)](https://github.com/neosubhamoy/neodlp/releases)
 [![PRs](https://img.shields.io/badge/PRs-welcome-blue.svg?style=flat)](https://github.com/neosubhamoy/neodlp)
 
+> [!TIP]
 > **🥰 Liked this project? Please consider giving it a Star (🌟) on github to show us your appreciation and help the algorythm recommend this project to even more awesome people like you!**
 
 [![Packaging status](https://repology.org/badge/vertical-allrepos/neodlp.svg)](https://repology.org/project/neodlp/versions)
 
-### ✨ Highlighted Features
+## ✨ Highlighted Features
 
 - Download Video/Audio from popular sites (YT, FB, IG, X and other 2.5k+ [supported sites](https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md))
 - Download Video/Audio in your preffered format (MP4, WEBM, MKV, MP3 etc.)
@@ -25,7 +26,7 @@ Cross-platform Video/Audio Downloader Desktop App with Modern UI and Browser Int
 - Network controls (proxy, rate limit etc.)
 - Highly customizable and many more...😉
 
-### 🧩 Browser Integration
+## 🧩 Browser Integration
 
 You can integrate NeoDLP with your favourite browser (any Chrome/Chromium/Firefox based browser) Just, install [NeoDLP Extension](https://github.com/neosubhamoy/neodlp-extension) to get started!
 
@@ -35,30 +36,34 @@ After installing the extension you can do the following directly from the browse
 
 - Right Click Context Menu Action (Download with Neo Downloader Plus - Link, Selection, Media Source)
 
-### 👀 Sneak Peek
+## 👀 Sneak Peek
 
-![NeoDLP-Mockup](./.github/mockup.svg)
+![NeoDLP-Mockup](./.github/images/mockup.svg)
 
-### 💻 Supported Platforms
+| Downloader | Completed Downloads | Ongoing Downloads | Settings |
+| :---- | :---- | :---- | :---- |
+| ![Downloader](./.github/images/downloader.png) | ![Completed-Downloads](./.github/images/completed-downloads.png) | ![Ongoing-Downloads](./.github/images/ongoing-downloads.png) | ![Settings](./.github/images/settings.png) |
+
+## 💻 Supported Platforms
 
 - Windows (10 / 11)
 - Linux (Debian / Fedora / RHEL / SUSE / Arch Linux base)
 - MacOS (>11)
 
-### 🤝 External Dependencies
+## 🤝 External Dependencies
 
 - [YT-DLP](https://github.com/yt-dlp/yt-dlp) - The core CLI tool used to download video/audio from the web (Hero of the show 😎)
 - [FFmpeg & FFprobe](https://www.ffmpeg.org) - Used for video/audio post-processing
 - [Aria2](https://aria2.github.io) - Used as an external downloader for blazing fast downloads with yt-dlp (Not included with NeoDLP MacOS builds)
 - [Deno](https://deno.com) - Provides sandboxed javascript runtime environment for yt-dlp (Required for YT downloads, as per the new yt-dlp [announcement](https://github.com/yt-dlp/yt-dlp/issues/14404))
 
-### ℹ️ System Pre-Requirements
+## ℹ️ System Pre-Requirements
 
 - **Windows:** [Microsoft Visual C++ Redistributable 2015+](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170) `winget install Microsoft.VCRedist.2015+.x64` (Will be auto-installed if you install NeoDLP via winget)
 - **MacOS:** XCode Command Line Tools `xcode-select --install` (Mostly, comes pre-installed on modern macos, still if you encounter any issue then try installing it manually)
 - **Linux:** Most linux packages comes with pre-defined system dependencies which will be auto installed by your package manager (if you are on `fedora` make sure to [enable rpmfusion free+nonfree repos](https://docs.fedoraproject.org/en-US/quick-docs/rpmfusion-setup/#_enabling_the_rpm_fusion_repositories_using_command_line_utilities) before installing the rpm package. also, if you prefer to install dependencies manually [follow this](https://v2.tauri.app/start/prerequisites/#linux))
 
-### ⬇️ Download and Installation
+## ⬇️ Download and Installation
 
 1. Download the latest [NeoDLP](https://github.com/neosubhamoy/neodlp/releases/latest) release based on your OS and CPU Architecture, then install it! -OR- Install it directly from an available distribution channel (listed below)
 
@@ -67,7 +72,8 @@ After installing the extension you can do the following directly from the browse
 | x86_64 | ✅ [Download](https://github.com/neosubhamoy/neodlp/releases/latest) | ✅ [Download](https://github.com/neosubhamoy/neodlp/releases/latest) | ✅ [Download](https://github.com/neosubhamoy/neodlp/releases/latest) |
 | ARM64 | ✅ Emulation | ✅ [Download](https://github.com/neosubhamoy/neodlp/releases/latest) | ✅ [Download](https://github.com/neosubhamoy/neodlp/releases/latest) |
 
-> 📌 **NOTE:** x86_64 Windows binary also works on ARM64 (Windows on ARM) devices with emulation (Not planning to release native Windows ARM64 build anytime soon as, x86_64 one works fine on ARM64 without noticeable performance impact)
+> [!NOTE]
+> x86_64 Windows binary also works on ARM64 (Windows on ARM) devices with emulation (Not planning to release native Windows ARM64 build anytime soon as, x86_64 one works fine on ARM64 without noticeable performance impact)
 
 | Platform (OS) | Distribution Channel | Installation Command / Instruction |
 | :---- | :---- | :---- |
@@ -76,10 +82,13 @@ After installing the extension you can do the following directly from the browse
 | Linux x86_64 / ARM64 | Curl-Bash Installer | `curl -sSL https://neodlp.neosubhamoy.com/linux_installer.sh \| bash` |
 | Arch Linux x86_64 / ARM64 | AUR | `yay -S neodlp` |
 
-### 🧪 Package Testing Status
+## 🧪 Package Testing Status
 
 Though NeoDLP is supported on most platforms but not all packages are tested on all platforms, to save some time (and brain cells) and ship the software as fast as possible! Current test coverage is given below. So, untested packages may have issues, test it yourself and always feel free to report any issue on github.
 
+> [!TIP]
+> If you have access to any of the untested systems listed below, you can test the packages there and send me the test results via creating an github issue! (that would be super helpful actualy 😊)
+
 | Platform | Status | Platform | Status |
 | :---- | :---- | :---- | :---- |
 | Windows 10 (x64) | ✅ Tested | Windows 10 (ARM64) | ⚠️ Untested |
@@ -93,7 +102,7 @@ Though NeoDLP is supported on most platforms but not all packages are tested on
 | openSUSE 16 (x64) | ⚠️ Untested | openSUSE 16 (ARM64) | ⚠️ Untested |
 | RHEL 10 (x64) | ⚠️ Untested | RHEL 10 (ARM64) | ⚠️ Untested |
 
-### 💝 Support the Development
+## 💝 Support the Development
 
 NeoDLP is and will be always FREE to Use and Open-Sourced for Everyone. On the other hand the developent process of NeoDLP takes lots of time, effort and even sometimes money! So, if you appriciate my work and have the ability to donate, then please consider supporting the development by donating (even a very small donation matters and helps NeoDLP to be a better product!) Your support is the key to my motivation...🤗
 
@@ -102,21 +111,23 @@ NeoDLP is and will be always FREE to Use and Open-Sourced for Everyone. On the o
 </a>
 <br></br>
 
-> 📌 **NOTE:** You can also donate via UPI by sending donations to this UPI ID directly: **subhamoybiswas636-2@oksbi**
+> [!NOTE]
+> You can also donate via UPI by sending donations to this UPI ID directly: **subhamoybiswas636-2@oksbi**
 
-### 🪜 Roadmap
+## 🪜 Roadmap
 
 - [x] Add support for yt-dlp
 - [x] Add basic settings and customization
 - [x] Integrate with browsers
 - [x] Add aria2c support
+- [x] Add custom command support
 - [ ] Add more advanced settings and achive stability **(ongoing)**
 - [ ] Add media converter
 - [ ] Add multiple downloader engines
 - [ ] Add advanced web extractor
 - [ ] Add more cool stuffs 😉
 
-### ⚡ Technologies Used
+## ⚡ Technologies Used
 
 ![Tauri](https://img.shields.io/badge/tauri-%2324C8DB.svg?style=for-the-badge&logo=tauri&logoColor=%23FFFFFF)
 ![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)
@@ -124,49 +135,50 @@ NeoDLP is and will be always FREE to Use and Open-Sourced for Everyone. On the o
 ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
 ![ShadCnUi](https://img.shields.io/badge/shadcn%2Fui-000000?style=for-the-badge&logo=shadcnui&logoColor=white)
 
-### 🛠️ Contributing / Building from Source
+## 🛠️ Contributing / Building from Source
 
 Want to be part of this? Feel free to contribute...!! Pull Requests are always welcome...!! (^_^) Follow these simple steps to start building:
 
 * Make sure to install [Rust](https://www.rust-lang.org/tools/install), [Node.js](https://nodejs.org/en), [Git](https://git-scm.com/downloads) and [Git-LFS](https://git-lfs.com/) before proceeding.
 * Install [Tauri Prerequisites](https://v2.tauri.app/start/prerequisites/) for your OS / platform
 1. Fork this repo in your github account.
-2. Git clone the forked repo in your local machine.
+2. Git clone the forked repo in your local machine. (**NOTE:** I've recently switched from GitHub LFS Server to my own self-hosted LFS Server! Cause GitHub LFS Storage is too expencive for me and NeoDLP requires a lots of LFS bandwidth. So, If you currently clone the repo it will clone the codebase but not the LFS Objects, If you want to clone the LFS Objects unfortunately you have to ask me for auth credentials - which will be only provided to you in certain conditions)
 3. Create a git branch (related to the feature you are working on) (Optional - Recommended)
 4. Install Node.js dependencies: `npm install`
 5. Run development / build process
-> ⚠️ **IMPORTANT:** Make sure to run the build command once before running the dev command for the first time to avoid compile time errors
+> [!WARNING]
+> Make sure to run the `build` command once before running the `dev` command for the first time to avoid compile time errors
 ```code
 # for windows users
-npm run tauri dev      # for development
+npm run tauri dev        # for development
 npm run tauri build      # for production build
 
 # for linux users
-npm run tauri dev -- --config "./src-tauri/tauri.linux-aarch64.conf.json"     # for ARM64 devices, development
+npm run tauri dev -- --config "./src-tauri/tauri.linux-aarch64.conf.json"       # for ARM64 devices, development
 npm run tauri build -- --config "./src-tauri/tauri.linux-aarch64.conf.json"     # for ARM64 devices, production build
 
-npm run tauri dev -- --config "./src-tauri/tauri.linux-x86_64.conf.json"     # for x64 devices, development
-npm run tauri build -- --config "./src-tauri/tauri.linux-x86_64.conf.json"     # for x64 devices, production build
+npm run tauri dev -- --config "./src-tauri/tauri.linux-x86_64.conf.json"        # for x64 devices, development
+npm run tauri build -- --config "./src-tauri/tauri.linux-x86_64.conf.json"      # for x64 devices, production build
 
 # for macOS users (based on cpu architecture)
-npm run tauri dev -- --config "./src-tauri/tauri.macos-aarch64.conf.json"     # for apple silicon macs, development
+npm run tauri dev -- --config "./src-tauri/tauri.macos-aarch64.conf.json"       # for apple silicon macs, development
 npm run tauri build -- --config "./src-tauri/tauri.macos-aarch64.conf.json"     # for apple silicon macs, production build
 
-npm run tauri dev -- --config "./src-tauri/tauri.macos-x86_64.conf.json"     # for intel x86 macs, development
-npm run tauri build -- --config "./src-tauri/tauri.macos-x86_64.conf.json"     # for intel x86 macs, production build
+npm run tauri dev -- --config "./src-tauri/tauri.macos-x86_64.conf.json"        # for intel x86 macs, development
+npm run tauri build -- --config "./src-tauri/tauri.macos-x86_64.conf.json"      # for intel x86 macs, production build
 ```
 6. Do the changes, Send a Pull Request with proper Description (NOTE: Pull Requests Without Proper Description will be Rejected)
 
-### ⭕ Bug Report
+## ⭕ Bug Report
 
 Noticed any Bug? or Want to give me some suggetion? Always feel free to open a [GitHub Issue](https://github.com/neosubhamoy/neodlp/issues). I would love to hear from you...!!
 
-### 💫 Credits
+## 💫 Credits
 
 - NeoDLP's 'Format Selection' options are inspired from the [Seal](https://github.com/JunkFood02/Seal) app by [@JunkFood02](https://github.com/JunkFood02)
 - Aria2 Windows x86_64 and Linux x86_64 static binaries are built by [@asdo92](https://github.com/asdo92/aria2-static-builds)
 
-### 📝 License
+## 📝 License
 
 NeoDLP is Licensed under the [MIT license](https://github.com/neosubhamoy/neodlp/blob/main/LICENSE). Anyone can view, modify, use (personal and commercial) or distribute it's sources without any attribution and extra permissions.