More readme, also test on 1.5

Author: nedbat

README.rst

@@ -1,29 +1,52 @@
 Django Template Coverage Plugin
 ===============================
 
-A coverage.py plugin to measure the coverage of Django templates.
+A `coverage.py`_ plugin to measure the coverage of Django templates.
 
-Details of how to use it are in this `blog post`_.  Real docs are TBD.
+Supported Python versions are 2.7 and 3.4.  Supported Django versions are 1.4
+through 1.8 alpha.
 
-.. _blog post: http://nedbatchelder.com/blog/201501/coveragepy_for_django_templates.html
+The plugin itself is pip installable::
 
+    $ pip install django_coverage_plugin
 
-To run the tests on Python 2.7::
+To run it, add this setting to your .coveragerc::
 
-    $ pip install -r requirements.txt
-    $ tox
+    [run]
+    plugins =
+        django_coverage_plugin
+
+Then run your tests under coverage.py. It requires the latest coverage.py, so
+it may not work with other coverage-related tools such as test-runner coverage
+plugins, or coveralls.io.
 
+You will see your templates listed in your coverage report alongside your
+Python modules.
 
-Yet to be done
+
+What the? How?
 --------------
 
-- Plugins can provide data to "debug sys".
+The technique used to measure the coverage is the same that Dmitry Trofimov
+used in `dtcov`_, but integrated into coverage.py as a plugin, and made more
+performant. I'd love to see how well it works in a real production project. If
+you want to help me with it, feel free to drop me an email.
+
+The coverage.py plugin mechanism is designed to be generally useful for hooking
+into the collection and reporting phases of coverage.py, specifically to
+support non-Python files. I've also got a plugin for Mako templates, but it
+needs some fixes from Mako. If you have non-Python files you'd like to support
+in coverage.py, let's talk.
 
-- Specialize debug tracing?
 
-- Figure out the path to the template so they aren't just simple file names
-  in the reports.
+Tests
+-----
+
+To run the tests::
+
+    $ pip install -r requirements.txt
+    $ tox
 
-- How to find unexecuted templates?
 
-- Docs
+.. _coverage.py: http://nedbatchelder.com/code/coverage
+.. _dtcov: https://github.com/traff/dtcov

requirements.txt

@@ -1,5 +1,5 @@
 # If you change this file, don't forget to update tox.ini and setup.py also.
 coverage >= 4.0a4
-Django
+Django >= 1.4
 six >= 1.4.0
 tox >= 1.8

setup.py

@@ -4,15 +4,15 @@
 
 setup(
     name='django_coverage_plugin',
-    version='0.3',
+    version='0.3.1',
     description='Django template coverage.py plugin',
     author='Ned Batchelder',
     author_email='[email protected]',
     url='https://github.com/nedbat/django_coverage_plugin',
     packages=['django_coverage_plugin'],
     install_requires=[
         # If you change this, update tox.ini and requirements.txt also.
-        'Django',
+        'Django >= 1.4',
         'coverage >= 4.0a4',
         'six >= 1.4.0',
     ],

tox.ini

@@ -1,12 +1,13 @@
 # tox configuration for django_coverage_plugin.
 
 [tox]
-envlist = py{27,34}-django{14,16,17,18},check
+envlist = py{27,34}-django{14,15,16,17,18},check
 
 [testenv]
 # Keep these dependencies in sync with the requirements.txt file.
 deps =
     django14: Django >=1.4, <1.5
+    django15: Django >=1.5, <1.6
     django16: Django >=1.6, <1.7
     django17: Django >=1.7, <1.8
     django18: Django >=1.8a1, <1.9