diff --git a/README.md b/README.md index 3ac99a6..f50e246 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,19 @@ youtube-dl wrapped in a simple web server. -[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/w33ble/youtube-dl-web/master/LICENSE) -[![npm](https://img.shields.io/npm/v/youtube-dl-web.svg)](https://www.npmjs.com/package/youtube-dl-web) -[![Project Status](https://img.shields.io/badge/status-experimental-orange.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index) +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/w33ble/youtube-dl-web/master/LICENSE) +[![Project Status](https://img.shields.io/badge/status-stable-limgreen.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index) -#### License +## Usage -MIT © [w33ble](https://github.com/w33ble) \ No newline at end of file +Meant to be used with Docker, but it would work locally if you have [youtube-dl](https://youtube-dl.org/) installed as well. + +```sh +docker run -it --rm -p 8080:8080 -v $PWD/data:/app/data w33ble/youtube-dl-web +``` + +Then hit `http://localhost:8080`, passing in a `url` and optionally a `format` query parameter for where to download from. + +## License + +MIT © [w33ble](https://github.com/w33ble)