diff --git a/README.md b/README.md index 811d5ab..5e5326d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ -# mediathek-viewer +# gtk-mediathek-player + +very simple python mediathek viewer for GNOME (using https://mediathekviewweb.de/'s API for search requests). + +![player widget](readme_images/player.jpeg) + +![search](readme_images/search.jpeg) + + + + + +## Installation + +tested on ubuntu 21.04 + +**dependencies** + +```bash +sudo apt install python3-pip gstreamer1.0-plugins-bad +``` + +**install directly from the git repository** + +``` +pip3 install --user git+https://the-cake-is-a-lie.net/gogs/jonas/mediathek-viewer.git +``` + +if the package is installed user or system wide, there should exist a new start menu entry after installation. Otherwise the program can be started manually with: + +```bash +python3 -m gtk_mediathek_player.main +``` -mediathek viewer written in python \ No newline at end of file diff --git a/readme_images/player.jpeg b/readme_images/player.jpeg new file mode 100644 index 0000000..4ea3035 Binary files /dev/null and b/readme_images/player.jpeg differ diff --git a/readme_images/search.jpeg b/readme_images/search.jpeg new file mode 100644 index 0000000..a2a1880 Binary files /dev/null and b/readme_images/search.jpeg differ