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

107 lines
5.9 KiB
Markdown
Raw Normal View History

Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
# [Streamlink][streamlink-website]
Update the README A bunch of things are happening in this PR: - Moving from .rst to markdown for the root directory - Updating the README with the relevant fork information - Removing LICENSE.flashmedia and LICENSE.pbs (these are imported from upstream packages) - Removing CONTRIBUTING.rst, we'll write a new manifest for this in the future that is more leniant than the past one.
2016-09-17 22:49:16 +02:00
cleanup: change build badge and link in README.md
2020-04-04 10:50:13 +02:00
[![Github build status][workflow-status-badge]][workflow-status]
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
[![codecov.io][codecov-coverage-badge]][codecov-coverage] [![Backers on Open Collective][opencollective-backers-badge]](#backers) [![Sponsors on Open Collective][opencollective-sponsors-badge]](#sponsors)
added travis build status badge fixes #74 (#76)
2016-10-08 06:25:01 +02:00
Updating README Applying changes from 1402fb0 to the README Closes #2880
2020-04-10 23:20:23 +02:00
Streamlink is a CLI utility which pipes video streams from various services into a video player, such as VLC.
Update the README A bunch of things are happening in this PR: - Moving from .rst to markdown for the root directory - Updating the README with the relevant fork information - Removing LICENSE.flashmedia and LICENSE.pbs (these are imported from upstream packages) - Removing CONTRIBUTING.rst, we'll write a new manifest for this in the future that is more leniant than the past one.
2016-09-17 22:49:16 +02:00
Updating README Applying changes from 1402fb0 to the README Closes #2880
2020-04-10 23:20:23 +02:00
The main purpose of streamlink is to avoid resource-heavy and unoptimized websites, while still allowing the user to enjoy various streamed content.
Update the README A bunch of things are happening in this PR: - Moving from .rst to markdown for the root directory - Updating the README with the relevant fork information - Removing LICENSE.flashmedia and LICENSE.pbs (these are imported from upstream packages) - Removing CONTRIBUTING.rst, we'll write a new manifest for this in the future that is more leniant than the past one.
2016-09-17 22:49:16 +02:00
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
Streamlink is a fork of the [Livestreamer][livestreamer] project.
Update the README A bunch of things are happening in this PR: - Moving from .rst to markdown for the root directory - Updating the README with the relevant fork information - Removing LICENSE.flashmedia and LICENSE.pbs (these are imported from upstream packages) - Removing CONTRIBUTING.rst, we'll write a new manifest for this in the future that is more leniant than the past one.
2016-09-17 22:49:16 +02:00
Make notice more agnostic
2017-04-05 19:35:03 +02:00
Please note that by using this application you're bypassing ads run by
sites such as Twitch.tv. Please consider donating or paying for subscription
services when they are available for the content you consume and enjoy.
Update readme so users are aware using Streamlink bypasses ads
2017-04-04 18:45:07 +02:00
Update the README with installation notes Yay 0.0.1 release! Streamlink is now on Pypi.
2016-09-23 22:41:57 +02:00
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
# [Installation][streamlink-installation]
Update the README with installation notes Yay 0.0.1 release! Streamlink is now on Pypi.
2016-09-23 22:41:57 +02:00
remove direct installation instructions, link to docs Remove the direct installation instruction containing "sudo" as well as manual installation, and link to the documentation instead. Fix links to documentation pages.
2019-10-03 11:16:31 +02:00
Please refer to our documentation for different ways to install Streamlink:
Updated homepage Added direct links to Linux/Mac/Windows installers
2016-12-07 03:31:21 +01:00
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
- [Windows][streamlink-installation-windows]
remove direct installation instructions, link to docs Remove the direct installation instruction containing "sudo" as well as manual installation, and link to the documentation instead. Fix links to documentation pages.
2019-10-03 11:16:31 +02:00
- [macOS][streamlink-installation-macos]
- [Linux and BSD][streamlink-installation-linux-and-bsd]
- [Source code][streamlink-installation-source]
Update the README with installation notes Yay 0.0.1 release! Streamlink is now on Pypi.
2016-09-23 22:41:57 +02:00
Update the README A bunch of things are happening in this PR: - Moving from .rst to markdown for the root directory - Updating the README with the relevant fork information - Removing LICENSE.flashmedia and LICENSE.pbs (these are imported from upstream packages) - Removing CONTRIBUTING.rst, we'll write a new manifest for this in the future that is more leniant than the past one.
2016-09-17 22:49:16 +02:00
# Features
Updating README Applying changes from 1402fb0 to the README Closes #2880
2020-04-10 23:20:23 +02:00
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:
Update the README A bunch of things are happening in this PR: - Moving from .rst to markdown for the root directory - Updating the README with the relevant fork information - Removing LICENSE.flashmedia and LICENSE.pbs (these are imported from upstream packages) - Removing CONTRIBUTING.rst, we'll write a new manifest for this in the future that is more leniant than the past one.
2016-09-17 22:49:16 +02:00
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
- [Twitch](https://www.twitch.tv)
docs: removed some notes, updated some urls removed hlsvariant:// documentation, hls:// is enough README.md - removed invalid note - update some URLs cli.rst - removed old note - added dash:// index.rst - update for https URLs install.rst - update for new Solus / Void URL - update for NixOS, found only this URL - update for Dependencies - PyPI URL update - removed old livestreamer issue ref 401 - use correct URL for Bintray changelog
2018-06-19 23:07:30 +02:00
- [YouTube](https://www.youtube.com)
Updating README Applying changes from 1402fb0 to the README Closes #2880
2020-04-10 23:20:23 +02:00
- [Livestream](https://livestream.com)
- [Dailymotion](https://www.dailymotion.com)
Update the README A bunch of things are happening in this PR: - Moving from .rst to markdown for the root directory - Updating the README with the relevant fork information - Removing LICENSE.flashmedia and LICENSE.pbs (these are imported from upstream packages) - Removing CONTRIBUTING.rst, we'll write a new manifest for this in the future that is more leniant than the past one.
2016-09-17 22:49:16 +02:00
Updating README Applying changes from 1402fb0 to the README Closes #2880
2020-04-10 23:20:23 +02:00
... and many more. A full list of plugins currently included can be found on the [plugin page][streamlink-plugins].
Update the README A bunch of things are happening in this PR: - Moving from .rst to markdown for the root directory - Updating the README with the relevant fork information - Removing LICENSE.flashmedia and LICENSE.pbs (these are imported from upstream packages) - Removing CONTRIBUTING.rst, we'll write a new manifest for this in the future that is more leniant than the past one.
2016-09-17 22:49:16 +02:00
# Quickstart
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
After installing, simply use:
Update the README with installation notes Yay 0.0.1 release! Streamlink is now on Pypi.
2016-09-23 22:41:57 +02:00
```
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
streamlink STREAMURL best
Update the README with installation notes Yay 0.0.1 release! Streamlink is now on Pypi.
2016-09-23 22:41:57 +02:00
```
Updating README Applying changes from 1402fb0 to the README Closes #2880
2020-04-10 23:20:23 +02:00
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].
Update the README with installation notes Yay 0.0.1 release! Streamlink is now on Pypi.
2016-09-23 22:41:57 +02:00
Update the README A bunch of things are happening in this PR: - Moving from .rst to markdown for the root directory - Updating the README with the relevant fork information - Removing LICENSE.flashmedia and LICENSE.pbs (these are imported from upstream packages) - Removing CONTRIBUTING.rst, we'll write a new manifest for this in the future that is more leniant than the past one.
2016-09-17 22:49:16 +02:00
# Contributing
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
All contributions are welcome.
Feel free to open a new thread on the issue tracker or submit a new pull request.
Please read [CONTRIBUTING.md][contributing] first. Thanks!
Added backers and sponsors on the README
2017-07-18 20:27:37 +02:00
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
[![Contributors][opencollective-contributors]][contributors]
Added backers and sponsors on the README
2017-07-18 20:27:37 +02:00
## Backers
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
Thank you to all our backers! \[[Become a backer][opencollective-backer]\]
Added backers and sponsors on the README
2017-07-18 20:27:37 +02:00
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
[![Backers on Open Collective][opencollective-backers-image]][opencollective-backers]
Added backers and sponsors on the README
2017-07-18 20:27:37 +02:00
## Sponsors
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. \[[Become a sponsor][opencollective-sponsor]\]
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/0/avatar.svg)](https://opencollective.com/streamlink/sponsor/0/website)
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/1/avatar.svg)](https://opencollective.com/streamlink/sponsor/1/website)
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/2/avatar.svg)](https://opencollective.com/streamlink/sponsor/2/website)
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/3/avatar.svg)](https://opencollective.com/streamlink/sponsor/3/website)
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/4/avatar.svg)](https://opencollective.com/streamlink/sponsor/4/website)
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/5/avatar.svg)](https://opencollective.com/streamlink/sponsor/5/website)
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/6/avatar.svg)](https://opencollective.com/streamlink/sponsor/6/website)
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/7/avatar.svg)](https://opencollective.com/streamlink/sponsor/7/website)
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/8/avatar.svg)](https://opencollective.com/streamlink/sponsor/8/website)
[![Open Collective Streamlink Sponsor](https://opencollective.com/streamlink/sponsor/9/avatar.svg)](https://opencollective.com/streamlink/sponsor/9/website)
[streamlink-website]: https://streamlink.github.io
[streamlink-plugins]: https://streamlink.github.io/plugin_matrix.html
[streamlink-documentation]: https://streamlink.github.io/cli.html
[streamlink-installation]: https://streamlink.github.io/install.html
remove direct installation instructions, link to docs Remove the direct installation instruction containing "sudo" as well as manual installation, and link to the documentation instead. Fix links to documentation pages.
2019-10-03 11:16:31 +02:00
[streamlink-installation-windows]: https://streamlink.github.io/install.html#windows
[streamlink-installation-macos]: https://streamlink.github.io/install.html#macos
[streamlink-installation-linux-and-bsd]: https://streamlink.github.io/install.html#linux-and-bsd
[streamlink-installation-source]: https://streamlink.github.io/install.html#source-code
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
[livestreamer]: https://github.com/chrippa/livestreamer
[contributing]: https://github.com/streamlink/streamlink/blob/master/CONTRIBUTING.md
[changelog]: https://github.com/streamlink/streamlink/blob/master/CHANGELOG.rst
[contributors]: https://github.com/streamlink/streamlink/graphs/contributors
cleanup: change build badge and link in README.md
2020-04-04 10:50:13 +02:00
[workflow-status]: https://github.com/streamlink/streamlink/actions?query=event%3Apush
[workflow-status-badge]: https://github.com/streamlink/streamlink/workflows/Test,%20build%20and%20deploy/badge.svg?branch=master&event=push
Restructure README.md See #1104 - Move all links to the readme footer (except certain external links) - Update all links and use https where possible - Fix markdown format (headers, lists, links, code blocks) - Reword paragraphs - Add more links to the Streamlink website - Use markdown for all Open Collective links and images - Reorder badges in the readme header - Add Open Collective link to the footer of the issue template
2017-07-27 18:43:51 +02:00
[codecov-coverage]: https://codecov.io/github/streamlink/streamlink?branch=master
[codecov-coverage-badge]: https://codecov.io/github/streamlink/streamlink/coverage.svg?branch=master
[opencollective-contributors]: https://opencollective.com/streamlink/contributors.svg?width=890
[opencollective-backer]: https://opencollective.com/streamlink#backer
[opencollective-backers]: https://opencollective.com/streamlink#backers
[opencollective-backers-image]: https://opencollective.com/streamlink/backers.svg?width=890
[opencollective-sponsor]: https://opencollective.com/streamlink#sponsor
[opencollective-backers-badge]: https://opencollective.com/streamlink/backers/badge.svg
[opencollective-sponsors-badge]: https://opencollective.com/streamlink/sponsors/badge.svg