From 84eeafa2f7706f57b5cd5762d8ea71db5861298d Mon Sep 17 00:00:00 2001 From: Joe Fleming Date: Tue, 31 Dec 2019 14:44:28 -0700 Subject: [PATCH] docs: add url usage example --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b54a4d4..8088833 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,17 @@ Meant to be used with Docker, but it would work locally if you have [youtube-dl] 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. +Then hit `http://localhost:8080`, passing in a `url` and optionally a `format` query parameter for where to download from. For example: + +```text +http://localhost:8080?url=https://www.youtube.com/watch?v=YE7VzlLtp-4 +``` + +You can also pass in additional arguments that would normally be passed on the command line as query parameters in the URL, like so: + +```text +http://localhost:8080?url=https://www.youtube.com/watch?v=YE7VzlLtp-4&format=mp3 +``` ### Automatic cleanup