Update README

This commit is contained in:
Ivan Habunek 2019-04-30 13:36:32 +02:00
parent e4e5a2be7e
commit 5df9099734
No known key found for this signature in database
GPG Key ID: CDBD63C43A30BB95

View File

@ -3,13 +3,23 @@ Twitch Downloader
A simple CLI tool for downloading videos from Twitch.
Inspired by youtube-dl but improves upon it by using multiple concurrent
connections to make the download faster.
Resources
---------
Homepage: https://github.com/ihabunek/twitch-dl
Issues: https://github.com/ihabunek/twitch-dl/issues
Python package: https://pypi.org/project/twitch-dl/
Usage
-----
List recent streams for a given channel:
```
λ twitch-dl videos bananasaurus_rex
twitch-dl videos bananasaurus_rex
```
Yields (trimmed):
@ -33,10 +43,22 @@ Bananasaurus_Rex playing Dead Space
Published 2018-01-21 @ 05:47:03 Length: 5h 7min
```
Download a stream by ID:
Download a stream by ID or URL:
```
twitch-dl download 221837124
twitch-dl download https://www.twitch.tv/videos/221837124
```
Man page
--------
Building the man page for twitch-dl requires scdoc.
The source is in ``twitch-dl.1.scd``, and you can build it by running:
```
make man
```
License