X-Git-Url: https://git.cweiske.de/phancap.git/blobdiff_plain/a943a81e773e41c84e6fee9b6010bacd4b4f7b82..bac895b61a812c1b0f014bae483fac8507fc44ee:/README.rst?ds=sidebyside

diff --git a/README.rst b/README.rst
index 2b823e9..818eafd 100644
--- a/README.rst
+++ b/README.rst
@@ -7,8 +7,38 @@ Web service (API) to create website screenshots.
 Self-hosted and written in PHP. Caching included.
 
 
+*phancap* is useful for:
+
+- Show screenshots for websites in your bookmarking application
+- Archive a HTML page as PDF for later viewing
+
+
 .. contents::
 
+
+========
+Features
+========
+
+* Configurable browser size
+* Configurable screenshot size
+* Clip and full page rendering (full height)
+* JPG, PNG and PDF output (PDFs are searchable)
+* Authentication
+* Can run on a normal web server without GUI. See dependencies_.
+* Generated images get meta data embedded:
+
+  * URL of captured page
+  * Capture settings
+
+
+.. note::
+    *phancap* does not rely on a "real" browser.
+    Currently ``cutycapt`` is utilized, which uses a pretty bare webkit to render
+    the pages.
+    Do not expect pixel-for-pixel identical rendering as your desktop browser.
+
+
 ===============
 Getting started
 ===============
@@ -17,10 +47,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
 ==============
@@ -100,6 +135,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``
@@ -228,13 +271,22 @@ This is the signature; it gets appended to the URL as ``asignature`` parameter.
 ============
 Dependencies
 ============
-- `cutycapt <http://cutycapt.sourceforge.net/>`_
-- imagemagick's ``convert``
-- ``xvfb-run``
-- PEAR's ``System.php``
+- External tools:
 
+  - `cutycapt <http://cutycapt.sourceforge.net/>`_
+  - `exiftool <http://owl.phy.queensu.ca/~phil/exiftool/>`_
+  - `imagemagick's <http://www.imagemagick.org/>`_ ``convert``
+  - ``xvfb-run``
+
+- Libraries (already included in the ``.phar``):
+
+  - PEAR's ``System.php``
+
+
+=============
+About phancap
+=============
 
-=======
 License
 =======
 ``phancap`` is licensed under the `AGPL v3`__ or later.
@@ -242,7 +294,6 @@ License
 __ http://www.gnu.org/licenses/agpl.html
 
 
-========
 Homepage
 ========
 Web site
@@ -254,7 +305,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