add deployment instructions

[phancap.git] / README.rst

diff --git a/README.rst b/README.rst
index 91b0fbb7f6f38fd59e9c431cac7b25b6af00b70e..34cc6f6518e79ef1cc97b323a4b435548e5f98d4 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -43,10 +43,15 @@ Basic setup
 ===========
 #. Download the ``.phar`` file and put it onto your web server
 #. Open the phar file in your browser
+
+   If you only see text beginning with ``<?php``, you need to
+   `setup .phar file extension handling`__ in your web server first.
 #. Click the "setup check" link
 #. Fix all errors that are reported
 #. Run ``phancap.phar/get.php?url=cweiske.de`` and see the screenshot
 
+__ http://cweiske.de/tagebuch/phar-webserver.htm
+
 
 Advanced setup
 ==============
@@ -126,6 +131,14 @@ Configuration variables
 
   ``true`` to allow access to anyone, ``false`` to disable it completely.
   ``array`` of username - secret key combinations otherwise.
+``$cutycapt['parameters']``
+  Additional command line parameters for cutycapt.
+  Can be used to e.g. enable browser plugins:
+
+  ``$cutycapt['parameters'] = '--plugins=on';``
+``$cutycapt['maxWaitTime']``
+  Maximal time in seconds to wait for cutycapt to finish rendering.
+  Defaults to 30 seconds.
 ``$disableSetup``
   Disable ``setup.php`` which will leak file system paths
 ``$redirect``
@@ -265,7 +278,10 @@ Dependencies
   - PEAR's ``System.php``
 
 
-=======
+=============
+About phancap
+=============
+
 License
 =======
 ``phancap`` is licensed under the `AGPL v3`__ or later.
@@ -273,7 +289,6 @@ License
 __ http://www.gnu.org/licenses/agpl.html
 
 
-========
 Homepage
 ========
 Web site
@@ -285,7 +300,29 @@ Source code
    Mirror: https://github.com/cweiske/phancap
 
 
-======
 Author
 ======
 Written by Christian Weiske, cweiske@cweiske.de
+
+
+============
+Alternatives
+============
+All of those are open source:
+
+* http://code.google.com/p/browsershots/ (python)
+* https://github.com/gre/screenshot-webservice (scala)
+
+
+===========
+Development
+===========
+
+Releasing a new version
+=======================
+
+#. Update ``ChangeLog``
+#. Change version number in ``build.xml``
+#. Run ``phing``
+#. Deploy the new files in ``dist/``
+#. Tag the new version in git