Update outdated README

This commit is contained in:
Bingus_Violet 2024-01-29 14:41:14 +00:00
parent 441ab83150
commit 1d9b3c0a22

View file

@ -1,11 +1,10 @@
# Univerter
A web youtube downloader & converter for youtube videos with no client-sided javascript. It can be found at https://yt.violets-purgatory.dev
A web downloader & converter for videos with no client-sided javascript. It can be found at https://yt.violets-purgatory.dev
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.
## Announcement
The developer branch is currently broken, as it is unfinished. Please don't report bugs yet.
Currently supports a wide variety of formats and sites, but if you have any other formats you want supported, please open an issue.
Formats added to Univerter must be supported by FFmpeg
Support for sites will only be added if those sites are supported by yt-dlp.
# Installation
@ -14,14 +13,14 @@ 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`
Port 8080 (or whatever you set the environment variable to) is exposed inside the container. It can be exposed with `-p`
Example:
```bash
docker run -p 8080:8080 bingusviolet/univerter
```
It can now be found on port 8080
This will allow it to be found on port 8080 (E.G. `localhost:8080`)
## Npm
## Node
1. Clone the repository
@ -35,6 +34,7 @@ cd YoutubeConverter
- [ffmpeg](https://github.com/FFmpeg/FFmpeg)
- [node](https://github.com/nodejs/node)
- [npm](https://github.com/npm/cli)
- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
3. Download NodeJS Dependencies