diff --git a/README.md b/README.md index 96f8526..7a85c47 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ ## Pre-requisites +* a passing familiarity with the command line * youtube-dl (plus any of its required dependencies, like ffmpeg) * golang compiler @@ -9,9 +10,13 @@ go build +## Binaries + +TBD + ## Running - ./gropple -port 8000 -address http://hostname:8000 -path /downloads + gropple -port 8000 -address http://hostname:8000 -path /downloads With no arguments, it will listen on port 8000 and use an address of 'http://localhost:8000'. @@ -21,4 +26,24 @@ a different address if you are running it behind a proxy server or similar. ## Using +Bring up `http://localhost:8000` (or your chosen address) in your browser. You should see a link to the bookmarklet at the top of the screen, and the list of downloads (currently empty). + +Drag the bookmarklet to your favourites bar, or otherwise bookmark it as you see fit. + +Whenever you are on a page with a video you would like to download, simply click the bookmarklet. + +A popup window will appear, the download will start on the your gropple server and the status will be shown in the window. + +You may close this window at any time without stopping the download, the status of all downloads is available on the index page. + +## TODO + +Many things. Please raise an issue. Known items: + +* queue downloads if too many started (maybe by domain) +* show logs from the index page +* process logs better to note post-processing (for instance when video and audio are downloaded separately and then combined) +* configurable options for youtube-dl, or the ability to use various youtube-dl forks + +