From 7ba3d296fa4cd935c8553f24694917662d97b3c0 Mon Sep 17 00:00:00 2001
From: Christian Weiske <cweiske@cweiske.de>
Date: Mon, 31 Mar 2014 14:59:06 +0200
Subject: [PATCH] document possible parameters and deps

---
 README.rst | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.rst b/README.rst
index 606ed74..02dbf80 100644
--- a/README.rst
+++ b/README.rst
@@ -7,6 +7,36 @@ Software to create screenshots and thumbnails of websites via an API.
 Self-hosted and written in PHP. Caching included.
 
 
+==============
+URL parameters
+==============
+``get.php`` supports the following parameters:
+
+``url``
+  Website URL
+``bwidth``
+  Browser width (default: 1024)
+``bheight``
+  Browser height (default: none)
+``swidth``
+  Screenshot width (default: none (no scaling))
+``sheight``
+  Screenshot height (default: none)
+``sformat``
+  Screenshot format (``png``, ``jpg``, ``pdf``, default: ``png``)
+``smode``
+  Screenshot mode (``screen`` (4:3) or ``page`` (full website height))
+
+
+============
+Dependencies
+============
+- `cutycapt <http://cutycapt.sourceforge.net/>`_
+- imagemagick's ``convert``
+- ``xvfb-run``
+
+
+
 =======================
 Technical brainstorming
 =======================
-- 
2.30.2