From 9ff75adbeae42f7889e061d8ece40b1f99460a5d Mon Sep 17 00:00:00 2001 From: Bingus_Violet Date: Mon, 20 Nov 2023 21:49:51 +0000 Subject: [PATCH] Update README.md --- README.md | 42 +++++++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index f59381d..b81673b 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,25 @@ -# No JS YoutubeConverter +# Univerter -A web youtube downloader & converter for youtube videos with no client-sided javascript. +A web youtube downloader & converter for youtube videos with no client-sided javascript. It can be found at https://yt.violets-purgatory.dev -# Dependencies - -- ffmpeg -- node -- npm - -# Supported formats - -Downloading mp4s & webms will give the fastest download, as they are downloaded directly from youtube. However, if you wish to use a different format, it will automatically convert the video to your preffered format. If there is a format not supported, please open a github issue. - -# Supported Websites - -Currently only supports youtube. No support for other sites is planned. +Currently supports a wide variety of formats, but only supports youtube. If you have any other sites you want supported, or any other formats, please open an issue. # Installation +There are 2 main ways to install Univerter: + +## Docker + +The docker image can be found at https://hub.docker.com/r/bingusviolet/univerter +Port 8080 (or whatever you set the environment variable to) is exposed inside the container. It can be changed with `-p` +Example: +```bash +docker run -p 5009:8080 bingusviolet/univerter +``` +It can now be found on port 5009 + +## Npm + 1. Clone the repository ```bash @@ -25,13 +27,19 @@ git clone https://github.com/Violets-puragtory/YoutubeConverter cd YoutubeConverter ``` -2. Download NodeJS Dependencies +2. Install Dependancies + +- ffmpeg +- node +- npm + +3. Download NodeJS Dependencies ```bash npm install ``` -# Usage +## Starting it` ```bash npm start