Skip to content

Commit

Permalink
Update usage.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
axelmierczuk authored Jan 11, 2022
1 parent 6ea744a commit 9e0c700
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,34 @@ Usage
Installation
------------

To install Sportyfin, you must have ``python3`` and ``pip`` installed on
your machine. Please see :doc:`requirements` for more details.
Pip
*****

Installation is as follows:
To install Sportyfin with pip, follow the steps bellow:

.. code:: console

.. code:: console
pip install sportyfin --no-binary=sportyfin
**NEW:** With Docker you can install and run as follows:
.. code:: console
Docker
*******

To install Sportyfin with Docker, follow the steps bellow:

.. code:: console
git clone <repo>
cd sportyfin
docker build --tag sportyfin .
docker run -v <Path Where You Want Output>:/sportyfin/output sportyfin
# For example: docker run -v ~/Desktop:/sportyfin/output sportyfin
_OR_ you may pull the container with the following:

.. code:: console
docker pull sportyfin/sportyfin:latest
docker run -v <Path Where You Want Output>:/sportyfin/output sportyfin/sportyfin:latest
Finding Streams
----------------
Expand Down

0 comments on commit 9e0c700

Please sign in to comment.