diff --git a/README.md b/README.md index 90921df..a46c739 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ A mobile friendly tool for downloading videos from social media. The backend is a Golang server that will take a URL (YouTube, Reddit, Twitter, etc), download the video file, and return a URL to directly download the video. The video will be transcoced as needed to produce a single mp4 file. +This is built on [youtube-dl](https://github.com/ytdl-org/youtube-dl) which has a list of [supported sites](http://ytdl-org.github.io/youtube-dl/supportedsites.html). + Note: This was written to run on a home network and wasn't originally written to be exposed to public traffic. Currently there's no auth. This might change and feel free to send a pull request, but right now, keep this on your internal network and do not expose it. ![Screenshot 1](https://i.imgur.com/lxwf1qU.png) @@ -11,7 +13,7 @@ Note: This was written to run on a home network and wasn't originally written to # Running -Pull the repo then run +Make sure you have [youtube-dl](https://github.com/ytdl-org/youtube-dl) and [FFmpeg](https://github.com/FFmpeg/FFmpeg) installed then pull the repo and run: ```bash ./run.sh ```