aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README22
1 files changed, 21 insertions, 1 deletions
diff --git a/README b/README
index 65e37bb..7ff49df 100644
--- a/README
+++ b/README
@@ -1 +1,21 @@
-Converts html to PDF using http://code.google.com/p/wkhtmltopdf/
+Converts html to PDF
+====================
+
+Provides a thin wrapper to the wkhtmltopdf binary from http://code.google.com/p/wkhtmltopdf/
+
+REQUIREMENTS
+============
+
+Install the binary http://code.google.com/p/wkhtmltopdf/
+ This may require libfontconfig (on Ububtu: sudo aptitude install libfontconfig)
+
+INSTALLATION
+============
+
+Add 'wkhtmltopdf' to INSTALLED_APPS.
+
+By default it will execute the first wkhtmltopdf command found on your PATH.
+You can set WKHTMLTOPDF_CMD to a specific execuatable:
+
+e.g.
+ WKHTMLTOPDF_CMD = '/path/to/my/wkhtmltopdf'