Merge pull request #125 from asherf/md

Fix markdown lint issues.

Author: asherf

.travis.yml

@@ -32,4 +32,4 @@ install:
 script:
   - pycodestyle django_prometheus/.
   - python setup.py test
-  - (cd django_prometheus/tests/end2end; PYTHONPATH=../../.. python manage.py test)
+  - cd django_prometheus/tests/end2end && PYTHONPATH=../../.. python manage.py test

CONTRIBUTING.md

@@ -15,21 +15,21 @@ run automatically.
 
 Please write unit tests for your change. There are two kinds of tests:
 
-  * Regular unit tests that test the code directly, without loading
-    Django. This is limited to pieces of the code that don't depend on
-    Django, since a lot of the Django code will require a full Django
-    environment (anything that interacts with models, for instance,
-    needs a full database configuration).
-  * End-to-end tests are Django unit tests in a test application. The
-    test application doubles as an easy way to interactively test your
-    changes. It uses most of the basic Django features and a few
-    advanced features, so you can test things for yourself.
+* Regular unit tests that test the code directly, without loading
+  Django. This is limited to pieces of the code that don't depend on
+  Django, since a lot of the Django code will require a full Django
+  environment (anything that interacts with models, for instance,
+  needs a full database configuration).
+* End-to-end tests are Django unit tests in a test application. The
+  test application doubles as an easy way to interactively test your
+  changes. It uses most of the basic Django features and a few
+  advanced features, so you can test things for yourself.
 
 ### Running all tests
 
 ```shell
-$ python setup.py test
-$ (cd tests/end2end/; PYTHONPATH=../.. ./manage.py test)
+python setup.py test
+cd tests/end2end/ &&  PYTHONPATH=../.. ./manage.py test
 ```
 
 The former runs the regular unit tests, the latter runs the Django
@@ -41,15 +41,15 @@ setup.py install`.
 ### Running the test Django app
 
 ```shell
-$ (cd tests/end2end/; PYTHONPATH=../.. ./manage.py runserver)
+cd tests/end2end/ &&  PYTHONPATH=../.. ./manage.py runserver
 ```
 
 By default, this will start serving on http://localhost:8000/. Metrics
 are available at `/metrics`.
 
 ## Running Prometheus
 
-See http://prometheus.io/docs/ for instructions on installing
+See <http://prometheus.io/docs/> for instructions on installing
 Prometheus. Once you have Prometheus installed, you can use the
 example rules and dashboard in `examples/prometheus/`. See
 `examples/prometheus/README.md` to run Prometheus and view the example

README.md

@@ -5,7 +5,6 @@ Export Django monitoring metrics for Prometheus.io
 [![Build Status](https://travis-ci.org/korfuri/django-prometheus.svg?branch=master)](https://travis-ci.org/korfuri/django-prometheus)
 [![PyPi page link -- Python versions](https://img.shields.io/pypi/pyversions/django-prometheus.svg)](https://pypi.python.org/pypi/django-prometheus)
 
-
 ## Usage
 
 ### Requirements
@@ -15,11 +14,13 @@ Export Django monitoring metrics for Prometheus.io
 ### Installation
 
 Install with:
+
 ```shell
 pip install django-prometheus
 ```
 
 Or, if you're using a development version cloned from this repository:
+
 ```shell
 python path-to-where-you-cloned-django-prometheus/setup.py install
 ```
@@ -127,7 +128,6 @@ there are unapplied migrations.
 If you want to disable the Django migration metrics, set the
 `PROMETHEUS_EXPORT_MIGRATIONS` setting to False.
 
-
 ### Monitoring and aggregating the metrics
 
 Prometheus is quite easy to set up. An example prometheus.conf to
@@ -174,7 +174,6 @@ Second step is to create the /metrics end point, for that we need
 another file (called urls_prometheus_wrapper.py in this example) that
 will wraps the apps URLs and add one on top:
 
-
 ```python
 from django.conf.urls import include, url