v1.3.3 - final for this version

Author: Jacobchestnut16

README.md

@@ -6,6 +6,44 @@ well as full playlists, and organizes logs for better control and recovery. Crea
 
 ---
 
+# Web-dlp-down-z
+
+**Web-dlp-down-z** is a media scraping and management tool that leverages `yt-dlp` to download 
+various types of media from different sources. It supports downloading individual media files as
+well as full playlists, and organizes logs for better control and recovery. Created using Flask-python
+
+---
+
+🐍 New to Python?
+No problem! You don’t need to write any Python code to use this tool.
+
+📦 **Quick Start**:
+1. Download the latest .zip file of the project.
+
+2. Extract it to a folder that’s easy to access (e.g., Desktop or Documents).
+
+3. Install Python (if it’s not already installed):
+
+   - Download from: https://www.python.org/downloads/
+
+   - Make sure to check the box that says “Add Python to PATH” during installation.
+
+Install dependencies:
+
+Open a terminal or command prompt in the folder you extracted, then run:
+`pip install -r requirements.txt`
+
+Start the app:
+`python app.py`
+
+Open your browser and go to:
+`http://localhost:8080` or if you know your ip address `http://<ip>:8080`
+
+That’s it! You’re now running Web-dlp-down-z on your local machine.
+
+>💡 Tip: If you're unfamiliar with terminal commands, just ask! This tool is made to work with zero programming experience.
+---
+
 ## ⚙️ Setup
 
 Make sure to set your download path in the `settings` tab default is linux:
@@ -14,6 +52,22 @@ Make sure to set your download path in the `settings` tab default is linux:
 - **Linux/macOS**:  
   `~/Downloads`
 
+Recommended: leave all `logs` and `files` in their default location. You can move them with the config settings.
+- download file is the default downloads list
+- playlist file is the default playlist list
+- logs are the yt-dlp logs ~ currently not active will contain nothing
+- processed are the log files of all downloaded content and all playlists flattened
+
+### Hierarchy
+This setting is important for users who want to sort their files automatically. By default this setting is turned off, to enable this enter `true`.
+- The hierarchy setting is configured to use `yt-dlp`'s metadata and sort files as follows `download_to/webpage_url_domain/uploader/<files>)`.
+  - `download_to` - the location you configured your download locations to go
+  - `webpage_url` - the name of the website you are downloading the video from
+  - `uploader` - the *creator* or *uploader* of the file your downloading
+
+Future plans for this setting are going to help umbrella videos more:
+- Custom tagging: `download_to/tag/`, `download_to/tag/webpage_url`, `download_to/tag/uploader`,  `download_to/tag/webpage_url/uploader`.   
+
 ---
 
 ## ✍️ Using the Tool – Editing Links
@@ -30,13 +84,12 @@ Saving:
 
 Setting install locations:
 - Each new group has default install locations:
-  - `Playlist` installs to its pared download list
-  - `Download` installs to the default location set in the `config file: edit this in teh  settings tab`
+  - `Playlist` installs to its paired download list
+  - `Download` installs to the default location set in the `config file: edit this in the  settings tab`
 - Each can be set to install to seperate locations:
   - `Playlist` is required to install to an existing download file
   - `Download` is required to install to an existing directory or folder
-  >        WARNING:
-  >        Each entry includes a **namespace** (a descriptive name or label). This is for logging and readability only; it does not affect the actual filenames.
+> WARNING: Each entry includes a **namespace** (a descriptive name or label). This is for logging and readability only; it does not affect the actual filenames.
 
 ---
 
@@ -58,15 +111,16 @@ The `view` section can be found in the settings tab with the top menu
 ## ✅ Features
 
 - Supports individual and playlist-based downloads
-- Reorderable queue system
+- Editable queue with save-and-execute option
+- Auto-retry for failed downloads
 - Automatic file naming from source titles
 - Automatic metadata generation if provided by the source
-- Logs for tracking success/failure and recovery
+- Logs and grouping for better management
 - Cross-platform support (Windows, Linux, macOS)
 
 ---
 
-## Whats New v1.3.2:
+## Whats New v1.3.3:
 
 - Execute tab is replaced with a Queue list.
 - Save now has an option to save an execute in the edit page
@@ -77,6 +131,10 @@ The `view` section can be found in the settings tab with the top menu
 - After a download starts it is no longer removed from the list if it fails
 - Downloads will now retry to download something 3 time before it quits
   - Retries happen at the end of the process
+- Downloads now have a stop function to stop downloading without leaving the page
+- Download lists now include 
+  - description by hovering over the row or image
+  - duration next to the image || serves as a way to indicate if the video is private as well
 
 ---
 
@@ -85,3 +143,5 @@ The `view` section can be found in the settings tab with the top menu
 - [yt-dlp](https://github.com/yt-dlp/yt-dlp)
 - Python 3.6+
 - Internet connection
+
+---