Add "--dry-run" ("-n") cli option

[playVideoOnDreamboxProxy.git] / README.rst

diff --git a/README.rst b/README.rst
index 045fea4d0f25a22593a673c47a07804ae270ca70..73318cce7a4abd716b2f99a9ea6f2153fc8a0c19 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,10 +1,37 @@
 ***********************************
 Play video on Dreambox proxy server
 ***********************************
-Server for the "Play video on Dreambox" android app.
+Server for the `"Play video on Dreambox" android app`__.
 
-Accepts an URL, runs ``youtube-dl`` on it to extract the video
-URL and lets the Dreambox satellite receiver play this file.
+Accepts an URL, runs `youtube-dl`__ on it to extract the video
+URL and lets the Dreambox__ satellite receiver play this file.
+
+
+__ http://cweiske.de/playVideoOnDreambox.htm#android
+__ http://rg3.github.io/youtube-dl/
+__ http://dream-multimedia-tv.de/
+
+
+=====
+Setup
+=====
+Point your web server's document root to the ``www/`` directory.
+
+Altenatively symlink the ``www/play.php`` file into your document root
+directory.
+
+
+Configuration
+=============
+You can adjust the path to ``youtube-dl`` and the Dreambox host name
+or IP address by creating a config file in ``data/config.php``.
+
+Simply copy ``data/config.php.dist`` onto ``data/config.php`` and adjust it.
+
+If your dreambox web interface is password protected, add the username
+and password to the ``$dreamboxUrl`` configuration variable::
+
+  $dreamboxUrl = 'http://user:pass@dreambox';
 
 
 =====
@@ -16,7 +43,26 @@ Send the web site URL via POST to ``play.php``::
           -H 'Content-type: text/plain'\
           http://proxy.example.org/play.php
 
+You can test it on command line, too::
+
+    $ php www/play.php http://example.org/page.htm
+
+Testing the URL selection without playing on the dreambox is possible::
+
+    $ php www/play.php http://example.org/page.htm --dry-run
+
+
 =======
 License
 =======
-This application is available under the AGPLv3 or later.
+This application is available under the `AGPL v3`__ or later.
+
+__ http://www.gnu.org/licenses/agpl.html
+
+
+======
+Author
+======
+Written by `Christian Weiske`__, cweiske@cweiske.de
+
+__ http://cweiske.de/