diff --git a/README.md b/README.md index f3378d9..1293467 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # fiddledl -A script for downloading fiddles from jsfiddle.net \ No newline at end of file +A script for downloading fiddles from jsfiddle.net + +## Usage + +``` +$ fiddledl -h +$ fiddledl -n NAME -i FIDDLE_ID -l LAST_REVISION [-f FIRST_REVISION] +``` + +| Option | Default | Required | Documentation | +|-----------------------|---------------|-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| -h | N/A | No | Show usage. | +| -n NAME | "" | No (if not specified, only FIDDLE_ID will be used) | A friendly name to append to the result directory to assist in locating later. | +| -i FIDDLE_ID | "" | Yes | The id of the fiddle you want to download. | +| -l LAST_REVISION | null | No (if not specified, FIRST_REVISION will be ignored and only the "base" revision will be downloaded. | The last revision of the fiddle you would like to download. | +| -f FIRST_REVISION | 1 | No | The first revision of the fiddle you would like to download. | + diff --git a/fiddledl.sh b/fiddledl.sh index 8b321ee..abdfb8c 100755 --- a/fiddledl.sh +++ b/fiddledl.sh @@ -63,7 +63,7 @@ while getopts ":hn:i:l:f:" opt; do echo " -h" echo " Show this help message." echo " -n NAME" - echo " A friendly name to append to the result directory to assist in finding later." + echo " A friendly name to append to the result directory to assist in locating later." echo " -i FIDDLE_ID" echo " The id of the fiddle you want to download." echo " -l LAST_REVISION"