Update README and development docs

[playVideoOnDreambox.git] / README.rst

diff --git a/README.rst b/README.rst
index 5dfb1bdc2b07f60e0934596aa5d68e979dbda315..13390f1b55e98925a7dea196568049c921f5225c 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -2,19 +2,36 @@
 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.
 
 Works fine with a Dreambox `DM7080 HD`__.
 
+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.
+
+__ https://www.mozilla.org/firefox
 __ http://www.dream-multimedia-tv.de/products
 __ http://www.dream-multimedia-tv.de/dm7080-hd
 
 .. contents::
 
 
+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 lists; no need to access the detail page anymore.
+- 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
 =====================
 In the addons manager
@@ -36,12 +53,23 @@ Dependencies
 
   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
 =======
-``playVideoOnDreambox`` is licensed under the `AGPL v3`__ or later.
+``playVideoOnDreambox`` is licensed under the `GPL v3`__ or later.
 
-__ http://www.gnu.org/licenses/agpl.html
+__ http://www.gnu.org/licenses/gpl.html
 
 
 Homepage
@@ -52,6 +80,10 @@ Source code
   http://git.cweiske.de/playVideoOnDreambox.git
 
   Mirror: https://github.com/cweiske/playVideoOnDreambox
+Firefox Add-ons site
+  https://addons.mozilla.org/de/firefox/addon/play-video-on-dreambox/
+Dreambox forum thread
+  http://www.dream-multimedia-tv.de/board/index.php?page=Thread&threadID=20224
 
 
 Author