Update README.md
This commit is contained in:
parent
e3ef87935e
commit
9ff75adbea
1 changed files with 25 additions and 17 deletions
42
README.md
42
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
|
||||
|
||||
- <a href="https://github.com/FFmpeg/FFmpeg">ffmpeg</a>
|
||||
- <a href="https://github.com/nodejs/node">node</a>
|
||||
- <a href="https://github.com/npm/cli">npm</a>
|
||||
|
||||
# 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
|
||||
|
||||
- <a href="https://github.com/FFmpeg/FFmpeg">ffmpeg</a>
|
||||
- <a href="https://github.com/nodejs/node">node</a>
|
||||
- <a href="https://github.com/npm/cli">npm</a>
|
||||
|
||||
3. Download NodeJS Dependencies
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
# Usage
|
||||
## Starting it`
|
||||
|
||||
```bash
|
||||
npm start
|
||||
|
|
Loading…
Reference in a new issue