From 040b3c6342253f10db4341ec80ad28a0ab321fed Mon Sep 17 00:00:00 2001 From: Ryu18 Date: Sat, 9 Oct 2021 22:43:11 +0200 Subject: [PATCH] updated readme --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5cd2e6d..ec5d7ac 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,30 @@ # Twspace-dl -Early development +A python script to download twitter space, only works on running spaces (for now). ## Usage +requires ffmpeg and the requests module ```bash -python twspace_dl/main.py -i space_id -ffmpeg -protocol_whitelist file,https,tls,tcp -i space_id.m3u8 -c copy space_id.aac +python twspace_dl/main.py space_id +``` + +## Features +Here's the output of the help option +``` +usage: main.py [-h] [-v] [-m] [-w] [-u] [-s] [-k] SPACE_ID + +Script designed to help download twitter spaces + +positional arguments: + SPACE_ID + +optional arguments: + -h, --help show this help message and exit + -v, --verbose + -m, --write-metadata + -w, --write-playlist write the m3u8 used to download the stream + -u, --url display the final url + -s, --skip-download + -k, --keep-files ```