github
/
streamlink
mirror of https://github.com/streamlink/streamlink
1
Fork 0
Code Releases Activity

Updating README 

Applying changes from 1402fb0 to the README
Closes #2880
This commit is contained in:
Colas Broux 2020-04-10 23:20:23 +02:00
parent e90d5f0e57
commit 1b5c052a8d
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -3,9 +3,9 @@
[![Github build status][workflow-status-badge]][workflow-status]
[![codecov.io][codecov-coverage-badge]][codecov-coverage] [![Backers on Open Collective][opencollective-backers-badge]](#backers) [![Sponsors on Open Collective][opencollective-sponsors-badge]](#sponsors)
Streamlink is a CLI utility that pipes flash videos from online streaming services to a variety of video players such as VLC.
Streamlink is a CLI utility which pipes video streams from various services into a video player, such as VLC.
The main purpose of streamlink is to convert CPU-heavy flash plugins to a less CPU-intensive format.
The main purpose of streamlink is to avoid resource-heavy and unoptimized websites, while still allowing the user to enjoy various streamed content.
Streamlink is a fork of the [Livestreamer][livestreamer] project.
@ -25,17 +25,15 @@ Please refer to our documentation for different ways to install Streamlink:
# Features
Streamlink is built via a plugin system which allows new services to be easily added.
Streamlink is built upon a plugin system which allows support for new services to be easily added.
Most of the big streaming services are supported, such as:
Supported streaming services, among many others, are:
- [Dailymotion](https://www.dailymotion.com)
- [Livestream](https://livestream.com)
- [Twitch](https://www.twitch.tv)
- [UStream](http://www.ustream.tv/explore/all)
- [YouTube](https://www.youtube.com)
- [Livestream](https://livestream.com)
- [Dailymotion](https://www.dailymotion.com)
A list of all supported plugins can be found on the [plugin page][streamlink-plugins].
... and many more. A full list of plugins currently included can be found on the [plugin page][streamlink-plugins].
# Quickstart
@ -46,8 +44,9 @@ After installing, simply use:
streamlink STREAMURL best
```
Streamlink will automatically open the stream in its default video player!
See [Streamlink's detailed documentation][streamlink-documentation] for all available configuration options, CLI parameters and usage examples.
The default behavior of Streamlink is to play back streams in the VLC player.
For more in-depth usage and install instructions, please refer to the [detailed documentation][streamlink-documentation].
# Contributing