aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorMatt Lenc <mattl@incuna.com>2014-06-19 12:31:34 +0100
committerMatt Lenc <mattl@incuna.com>2014-06-19 12:31:34 +0100
commit5f8dbc3ef7789c4ea4ec3d7eb1526fe847c5da50 (patch)
treec02d4955590238f597fa25f464044a07f260be90 /README.rst
parent8e615cf00343d61e2bf3716c66888758aeb878ed (diff)
downloaddjango-wkhtmltopdf-5f8dbc3ef7789c4ea4ec3d7eb1526fe847c5da50.tar.gz
django-wkhtmltopdf-5f8dbc3ef7789c4ea4ec3d7eb1526fe847c5da50.tar.bz2
django-wkhtmltopdf-5f8dbc3ef7789c4ea4ec3d7eb1526fe847c5da50.zip
Fix links in README & add some badges
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst33
1 files changed, 21 insertions, 12 deletions
diff --git a/README.rst b/README.rst
index a61a069..e7b1bfb 100644
--- a/README.rst
+++ b/README.rst
@@ -1,26 +1,31 @@
django-wkhtmltopdf
==================
+.. image:: https://badge.fury.io/py/django-wkhtmltopdf.png
+ :target: http://badge.fury.io/py/django-wkhtmltopdf
+ :alt: Latest version
+
.. image:: https://travis-ci.org/incuna/django-wkhtmltopdf.png
:target: https://travis-ci.org/incuna/django-wkhtmltopdf
+ :alt: Travis-CI
+
+.. image:: https://pypip.in/d/django-wkhtmltopdf/badge.png
+ :target: https://crate.io/packages/django-wkhtmltopdf/
+ :alt: Number of PyPI downloads
Converts html to PDF
--------------------
-Provides a thin Django wrapper for the `wkhtmltopdf`_ binary.
-
-.. _wkhtmltopdf: http://wkhtmltopdf.org/
+Provides a thin Django wrapper for the `wkhtmltopdf <http://wkhtmltopdf.org>`_ binary.
Requirements
------------
-Install the `wkhtmltopdf`_ binary.
+Install the `wkhtmltopdf <http://wkhtmltopdf.org/downloads.html>`_ binary.
This requires libfontconfig (on Ubuntu: ``sudo aptitude install libfontconfig``).
-.. _wkhtmltopdf: http://wkhtmltopdf.org/downloads.html
-
Python 2.6+ and 3.3+ is supported.
@@ -36,20 +41,24 @@ By default it will execute the first ``wkhtmltopdf`` command found on your ``PAT
If you can't add wkhtmltopdf to your ``PATH``, you can set ``WKHTMLTOPDF_CMD`` to a
specific execuatable:
-e.g.: in ``settings.py``::
+e.g. in ``settings.py``: ::
WKHTMLTOPDF_CMD = '/path/to/my/wkhtmltopdf'
-or alternatively as env variable::
+or alternatively as env variable: ::
export WKHTMLTOPDF_CMD=/path/to/my/wkhtmltopdf
-You may also set
-``WKHTMLTOPDF_CMD_OPTIONS``
-in ``settings.py`` to a dictionary of default command-line options.
+You may also set ``WKHTMLTOPDF_CMD_OPTIONS`` in ``settings.py`` to a dictionary
+of default command-line options.
-The default is::
+The default is: ::
WKHTMLTOPDF_CMD_OPTIONS = {
'quiet': True,
}
+
+License
+-------
+
+MIT licensed. See the bundled `LICENSE <https://github.com/incuna/django-wkhtmltopdf/blob/master/LICENSE>`_ file for more details.