Use restructured text rather than Markdown

Author: Janneke Janssen

MANIFEST.in

@@ -1,5 +1,5 @@
 include LICENSE
-include README.md
+include README.rst
 include MANIFEST.in
 
 recursive-include testhook *.py

README.md

@@ -0,0 +1,117 @@
+django-testhook
+===============
+
+A Django template tag to enable testhook attributes on HTML elements.
+
+.. image:: https://travis-ci.org/jjanssen/django-testhook.svg?branch=master
+    :target: http://travis-ci.org/jjanssen/django-testhook
+.. image:: https://img.shields.io/pypi/v/django-testhook.svg
+    :target: https://pypi.python.org/pypi/django-testhook/
+.. image:: https://img.shields.io/pypi/dm/django-testhook.svg
+    :target: https://pypi.python.org/pypi/django-testhook/
+.. image:: https://img.shields.io/badge/wheel-yes-green.svg
+    :target: https://pypi.python.org/pypi/django-testhook/
+.. image:: https://img.shields.io/pypi/l/django-testhook.svg
+    :target: https://pypi.python.org/pypi/django-testhook/
+.. image:: https://img.shields.io/pypi/pyversions/Django.svg
+    :target: https://pypi.python.org/pypi/django-testhook/
+.. image:: https://coveralls.io/repos/jjanssen/django-testhook/badge.svg?branch=master
+    :target: https://coveralls.io/github/jjanssen/django-testhook?branch=master
+
+About django-testhook
+---------------------
+
+The django-testhook provides a template tag to generate
+``data-testhook-id`` for HTML templates.
+
+This can be useful for automated testing (for eg:
+`Webdriver.IO <http://www.webdriver.io>`__) to maintain a fixed entry
+point, rather than having a automated test that breaks by just renaming
+a CSS class or an element which can require you to re-evaluate an
+XPath-selector.
+
+Requirements
+------------
+
+Django 1.8.x or greater, Python 2.7 or greater.
+
+Installation
+------------
+
+Install django-testhook with pip:
+
+::
+
+    $ pip install django-testhook
+
+Configuration
+-------------
+
+Configuring django-testhook
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Add the following to your settings file:
+
+.. code:: python
+
+    INSTALLED_APPS += (
+        'testhook',
+    )
+
+Available settings
+~~~~~~~~~~~~~~~~~~
+
+By default the rendering of testhook data attributes is enabled. If you
+are in the scenario you want to disable it for a certain environment
+just configure it to ``False``.
+
+.. code:: python
+
+    TESTHOOK_ENABLED = False
+
+Usage
+-----
+
+Basic usage
+~~~~~~~~~~~
+
+Within your HTML template you must load the testhook tag in order to use
+it. The testhook tag only requires a single argument in order to return
+a result.
+
+.. code:: html
+
+    {% load testhook %}
+
+    <div class="my-elem" {% testhook "test-elem" %}>
+        I want to test this
+    </div>
+
+This will output to the following:
+
+.. code:: html
+
+    <div class="my-elem" data-testhook-id="test-elem">
+        I want to test this
+    </div>
+
+Object Usage
+~~~~~~~~~~~~
+
+For dynamic elements there is also the option to pass arguments. For eg:
+given I have a product in a shopping basket with a primary key and a
+slug I could use it like this:
+
+.. code:: html
+
+    <div class="item" {% testhook "basket" product.id product.slug %}>
+        {{ product.title }}
+    </div>
+
+It will output to:
+
+.. code:: html
+
+    <div class="item" data-testhook-id="basket-1-product-slug">
+        A product title
+    </div>

README.rst

@@ -3,4 +3,4 @@
 universal = 1
 
 [metadata]
-description-file = README.md
+description-file = README.rst

setup.cfg

@@ -19,7 +19,7 @@
 
     description='''A Django template tag to enable testhook
         attributes on HTML elements.''',
-    long_description=open('README.md').read(),
+    long_description=open('README.rst').read(),
 
     author='Janneke Janssen',
     author_email='[email protected]',