peerflix: expand based on official docs

- add a torrent url example
- add the --list and --subtitles options
- make the magnet link example more realistic:
  BitTorrent info hashes (BTIH) are hex-encoded SHA-1 hash sums of the "info" sections of BitTorrent metafiles;
  SHA-1 hash values are typically rendered as a hexadecimal number, 40 digits long.
- replace "your favorite player" with "a media player" in the main description
- clarify which files from the torrent will be streamed in each case
coverage
Waldir Pimenta 2017-09-01 08:09:33 -01:00 committed by GitHub
parent 7d92f9154a
commit 802eb6c5af
1 changed files with 14 additions and 6 deletions

View File

@ -1,15 +1,23 @@
# peerflix
> Stream video or audio based torrents to your favorite player.
> Stream video- or audio-based torrents to a media player.
- Stream a torrent:
- Stream the largest media file in a torrent given as a magnet link:
`peerflix "{{magnet:?xt=urn:btih:00112233445566}}"`
`peerflix "{{magnet:?xt=urn:btih:0123456789abcdef0123456789abcdef01234567}}"`
- Stream a torrent to VLC:
- Stream the largest file in a torrent, given as a torrent URL, to VLC:
`peerflix "{{torrent url|magnet link}}" --vlc`
`peerflix "{{http://example.net/music.torrent}}" --vlc`
- Stream the largest file in a torrent to MPlayer, with subtitles:
`peerflix "{{torrent_url|magnet_link}}" --mplayer --subtitles subtitle-file.srt`
- Stream all files from a torrent to Airplay:
`peerflix "{{torrent url|magnet link}}" --all --airplay`
`peerflix "{{torrent_url|magnet_link}}" --all --airplay`
- List the files in a torrent that are available for streaming:
`peerflix "{{torrent_url|magnet_link}}" --list`