Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
chrippa committed Aug 16, 2014
1 parent 98f472c commit b4470f3
Showing 1 changed file with 34 additions and 49 deletions.
83 changes: 34 additions & 49 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,77 +10,62 @@ Livestreamer
.. image:: https://pypip.in/d/livestreamer/badge.png
:target: https://crate.io/packages/livestreamer?version=latest

.. image:: docs/_static/flattr-badge.png
:target: https://flattr.com/submit/auto?user_id=chrippa&url=https%3A%2F%2Fgithub.com%2Fchrippa%2Flivestreamer

Overview
--------

Livestreamer is CLI program that extracts streams from various services and pipes them into
a video player of choice.
Livestreamer is a `command-line utility`_ that pipes video streams
from various services into a video player, such as `VLC <http://videolan.org/>`_.
The main purpose of Livestreamer is to allow the user to avoid buggy and CPU
heavy flash plugins but still be able to enjoy various streamed content.
There is also an `API`_ available for developers who want access
to the video stream data.

* Documentation: http://livestreamer.tanuki.se/
* Discussions: https://groups.google.com/forum/#!forum/livestreamer
* IRC: #livestreamer @ Freenode
* GitHub: https://github.com/chrippa/livestreamer
* PyPI: https://pypi.python.org/pypi/livestreamer
* Free software: Simplified BSD license
- Documentation: http://livestreamer.tanuki.se/
- Issue tracker: https://github.com/chrippa/livestreamer/issues
- PyPI: https://pypi.python.org/pypi/livestreamer
- Discussions: https://groups.google.com/forum/#!forum/livestreamer
- IRC: #livestreamer @ Freenode
- Free software: Simplified BSD license

.. _command-line utility: http://livestreamer.tanuki.se/en/latest/cli.html
.. _API: http://livestreamer.tanuki.se/en/latest/api_guide.html

Features
--------

Livestreamer is built upon a plugin system which allows support for new services
to be easily added.

Currently most of the big streaming services are supported, e.g.
`Dailymotion <http://dailymotion.com/live/>`_,
`Livestream <http://livestream.com>`_,
`Justin.tv <http://justin.tv>`_,
`Twitch <http://twitch.tv/>`_,
`UStream <http://ustream.tv>`_ and
`YouTube Live <http://youtube.com/live/>`_.

Installing
----------

The latest stable version is available to install using `pip <http://www.pip-installer.org/>`_:

.. code-block:: bash
$ pip install livestreamer
to be easily added. Currently most of the big streaming services are supported,
such as:

or installing from a source directory:
- `Dailymotion <http://dailymotion.com/live>`_
- `Livestream <http://livestream.com>`_
- `Twitch <http://twitch.tv>`_
- `YouTube Live <http://youtube.com>`_
- `UStream <http://ustream.tv>`_

.. code-block:: bash
... and many more. A full list of plugins currently included can be found
on the `Plugins`_ page.

$ python setup.py install
.. _Plugins: http://livestreamer.tanuki.se/en/latest/plugin_matrix.html

`The Hitchhiker’s Guide to Python <http://docs.python-guide.org/>`_ has guides
helping you install Python + pip on the most common operating systems.
Quickstart
-----------

Updating
----------
The default behaviour of Livestreamer is to playback a stream in the default
player (`VLC <http://videolan.org/>`_).

.. code-block:: bash
$ pip install --upgrade livestreamer
Usage
-----

The default behaviour of Livestreamer is to transport a stream to your player
software (default is VLC).

.. code-block:: console
.. sourcecode:: console

# pip install livestreamer
$ livestreamer twitch.tv/day9tv best
[cli][info] Found matching plugin twitch for URL twitch.tv/day9tv
[cli][info] Opening stream: source
[cli][info] Starting player: vlc

For more in-depth usage and install instructions see the `User guide`_.

For more in-depth usage and install instructions see the full documentation available
at http://livestreamer.tanuki.se/.

.. _User guide: http://livestreamer.tanuki.se/en/latest/index.html#user-guide

Related software
----------------
Expand Down

0 comments on commit b4470f3

Please sign in to comment.