aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md32
1 files changed, 21 insertions, 11 deletions
diff --git a/README.md b/README.md
index 7ff49df..219d4e1 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,31 @@
+django-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)
+Requirements
+------------
+
+Install the [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/) binary.
+This requires libfontconfig (on Ububtu: `sudo aptitude install libfontconfig`).
+
+
+Installation
+------------
+
+Run `pip install django-wkhtmltopdf`.
-INSTALLATION
-============
+Add `'wkhtmltopdf'` to `INSTALLED_APPS` in your `settings.py`.
-Add 'wkhtmltopdf' to INSTALLED_APPS.
+By default it will execute the first wkhtmltopdf command found on your `PATH`.
-By default it will execute the first wkhtmltopdf command found on your PATH.
-You can set WKHTMLTOPDF_CMD to a specific execuatable:
+If you can't add wkhtmltopdf to your `PATH`, you can set `WKHTMLTOPDF_CMD` to a
+specific execuatable:
-e.g.
+e.g.: in `settings.py`
WKHTMLTOPDF_CMD = '/path/to/my/wkhtmltopdf'