diff --git a/README.md b/README.md index 7350bc4..c99ef2c 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,54 @@ -### YouTubeDownloader +# YouTube Downloader -Basic self hosted, private YouTube downloader client +A simple, self-hosted YouTube downloader that allows you to download videos and audio from YouTube. Built with Flask and yt-dlp. -### Installation +## Features + +- 🎥 Download YouTube videos in best quality +- 🎵 Extract audio as MP3 files +- 🌐 Simple web interface +- 🏃♂️ Easy to set up and run +- 🔒 Private and self-hosted + +## Prerequisites + +- Python 3.6+ +- FFmpeg (required for audio downloads) + +## Installation + +1. Clone the repository: + +git clone https://gitea.patrolbuddygo.com/wesleyneuhaus/YouTubeDownloader.git +cd YouTubeDownloader + +2. Install dependencies: pip install -r requirements.txt -# (Optional for audio-only downloads) Install ffmpeg -https://ffmpeg.org/download.html # Download to this directory or add to PATH +3. Install FFmpeg (required for audio downloads): + - Download from [FFmpeg's official website](https://ffmpeg.org/download.html) + - Either place the FFmpeg executable in the project directory or add it to your system PATH -### Usage +## Usage + +1. Start the server: python main.py -# From here, simply open the HTML file in your browser. -### Update +2. Open your web browser and navigate to: + +http://localhost:5000 + + +3. Enter a YouTube URL and select your preferred download format (video or audio) + +4. Click "Download" and wait for the process to complete + +## Updating + +To update to the latest version: git pull +pip install -r requirements.txt diff --git a/index.html b/index.html index a059f66..aeebfd4 100644 --- a/index.html +++ b/index.html @@ -1,10 +1,14 @@ - + +
+