Update README and development docs
[playVideoOnDreambox.git] / README.rst
index 2a4c32424cccf298d13e83ae34d0c8ab7a062bd1..13390f1b55e98925a7dea196568049c921f5225c 100644 (file)
@@ -2,7 +2,7 @@
 Play video on Dreambox
 **********************
 
 Play video on Dreambox
 **********************
 
-Firefox addon (extension) that adds a "Play on Dreambox" button to the
+Firefox__ browser addon (extension) that adds a "Play on Dreambox" button to the
 toolbar.
 Pressing it plays the video of the current tab on your Dreambox__ satellite
 receiver.
 toolbar.
 Pressing it plays the video of the current tab on your Dreambox__ satellite
 receiver.
@@ -13,6 +13,7 @@ You can also right-click a link to a video page and select
 "Play linked video on Dreambox".
 That way you don't even need to open video detail pages.
 
 "Play linked video on Dreambox".
 That way you don't even need to open video detail pages.
 
+__ https://www.mozilla.org/firefox
 __ http://www.dream-multimedia-tv.de/products
 __ http://www.dream-multimedia-tv.de/dm7080-hd
 
 __ http://www.dream-multimedia-tv.de/products
 __ http://www.dream-multimedia-tv.de/dm7080-hd
 
@@ -22,9 +23,13 @@ __ http://www.dream-multimedia-tv.de/dm7080-hd
 Features
 ========
 - Toolbar button to play the video on the current page
 Features
 ========
 - Toolbar button to play the video on the current page
-- Context menu item to play the video on the linked page
-  (nice for video list; no need to access the detail page anymore)
+- Context menu item to play the video on the linked page.
+  Nice for video lists; no need to access the detail page anymore.
 - Dreambox web interface access token support
 - Dreambox web interface access token support
+- Supports hundreds of video sites, see the `youtube-dl site support list`__.
+- Errors are displayed via the operating system's notification system
+
+__ http://rg3.github.io/youtube-dl/supportedsites.html
 
 
 Configuration options
 
 
 Configuration options
@@ -48,6 +53,17 @@ Dependencies
 
   https://github.com/rg3/youtube-dl
 
 
   https://github.com/rg3/youtube-dl
 
+  The version packaged in the Debian repository is pretty old;
+  it's better to use the recent PyPi version::
+
+    $ pip install youtube-dl
+
+Dreambox extensions
+  The following extensions have to be installed on your Dreambox:
+
+  - Media Player (``enigma2-plugin-extensions-mediaplayer``)
+  - Webinterface (``enigma2-plugin-extensions-webinterface``)
+
 
 License
 =======
 
 License
 =======