diff --git a/README.md b/README.md new file mode 100644 index 0000000..3e6f462 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# HLSGET + +A tool to get a HLS video stream. + +## Synopsis + +Usage: hlsget [OPTIONS] --name --url + +Options: + -n, --name + -u, --url + -b, --buffer request to store in client after concurrency limit reached [default: 10] + -r, --rate number of requests per second the client should perform [default: 40] + -c, --concurrency number of concurrent requests [default: 20] + -t, --timeout network io timeout [default: 30] + -B also use timeout on body reads + -R prevent reconnect after each iteration + -w wait for temporary failure like 503 [default: 301] + -o, --origin + -a, --agent + -v... Increase verbosity + -h, --help Print help + -V, --version Print version + +## Description + +It downloads the m3u8 as well as all ts files. After that ffmpeg is called to merge these into a single mp4 file. + +The download is performed concurrently and the amount of concurrent download as well as the request rate and other things are configurable through CLI. + +The progress is visualized through progress bars for each ts download. + +## Requirements + +[:Requirements:] + +## Dependencies + +[:Dependencies:] + +## Contributing + +[:Contributing:] + +## License + +Copyright © 2025 Georg Hopp + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +## Author + +Georg Hopp