Browse Source

update documentation on the newly supported video sites

Helmut Pozimski 6 years ago
parent
commit
f91eca6ffe
2 changed files with 28 additions and 3 deletions
  1. 26 1
      README.md
  2. 2 2
      doc/commandline.rst

+ 26 - 1
README.md

@@ -1,6 +1,6 @@
 # ABOUT
 
-stov is a program which allows you to subscribe to channels, playlists and search results on youtube. (More platforms will be implemented later) You don't need a youtube account for the program to work since it retrieves the needed data using youtube-dl. You can for example run it as a cron job to automatically download your favourite videos.
+stov is a program which allows you to subscribe to channels, playlists and search results on youtube, ZDF Mediathek, twitch.tv and vid.me. You don't need an account on these sites for the program to work since it retrieves the needed data using youtube-dl. You can for example run it as a cron job to automatically download your favourite videos.
 
 ## USAGE
 
@@ -50,6 +50,31 @@ By default, the configuration is defined in ~/stov/stov.json in the json format.
 	Videos whose titles don't match the search string will be entirely ignored.
 	valid values: yes or no
 
+## Sites
+
+The following sites are currently supported:
+
+* Youtube
+* ZDF Mediathek
+* Twitch.tv
+* Vid.me
+
+### Youtube
+
+For this site, all features are supported, you can subscribe to users, channels (via channel ID), global searches or playlists.
+
+### ZDF Mediathek
+
+Only the "channel" subscription type is supported. The string you put in as the channel name will be used to select broadcasts from all of the available ones to download. Since it uses the "Sendung verpasst?" feature of the json API, you should run stov at least daily to catch all broadcasts.
+
+### Twitch.tv
+
+This site only supports the "channel" subscription type. You can select videos from a channel by adding an optional "search" parameter.
+
+### Vid.me
+
+This site only supports the "channel" subscription type. You can select videos from a channel by adding an optional "search" parameter.
+
 ## KNOWN ISSUES
 
 Currently none, contact me if you find any.

+ 2 - 2
doc/commandline.rst

@@ -9,8 +9,8 @@ COMMAND LINE OPTIONS
 -s search-parameter, --search=search-parameter	optionally add a search string to a new channel subscription or create a new search subscription (requires --add)
 --lssubs	list the currently available subscriptions
 --lsvids=subscription-id	print all videos from a subscription
--u, --update	updates the information about the available videos
--d, --download	download all available videos which haven't already been downloaded
+-u, --update {sub_id}	updates the information about the available videos
+-d, --download {sub_id}	download all available videos which haven't already been downloaded
 --catchup=subscription-id	mark all videos from one channel as read (requires subscription-id as argument)
 -r subscription-id, --remove=subscription-id	remove a subscription
 -c, --clean-database	clean the database of entries no longer listed in the current API response