Rename and update README.rst to README.md

Author: stephane

MANIFEST.in

@@ -1,4 +1,4 @@
-include CHANGES.txt CONTRIBUTORS.txt LICENSE.txt README.rst
+include CHANGES.txt CONTRIBUTORS.txt LICENSE.txt README.md
 
 graft webstack_django_sorting
 

README.rst README.mdREADME.rst renamed to README.md

@@ -4,10 +4,10 @@ webstack-django-sorting
 What?
 -----
 
-``webstack-django-sorting`` is a Django app which allows for easy sorting of
+`webstack-django-sorting` is a Django app which allows for easy sorting of
 data tables. You don't need to change anything to your views to use it. It
 provides sorting links for table headers. It is the perfect companion of
-`django-pagination <https://github.com/zyga/django-pagination>`_.
+[django-pagination](https://github.com/zyga/django-pagination).
 
 A demonstration of the features is provided in `testproj` directory.
 
@@ -18,29 +18,32 @@ Features
 - Switches between ascending, descending, and no sorting
 - Provides links to sort on different criterions
 - Visual feedback on applied ordering
-- Supports Python 2.7, 3.5 and 3.6
+- Supports Python 2.7, 3.5+
 - Supports translation of link titles
 
-Upgrade from v0.5.0 and below
------------------------------
+Upgrade from v0.5.0
+-------------------
 
-To upgrade to ``webstack-django-sorting`` v1.0.0+, you must remove the old middleware
-``webstack_django_sorting.middleware.SortingMiddleware`` from ``MIDDLEWARE_CLASSES`` list.
+To upgrade to `webstack-django-sorting` v1.0.0+, you must remove the old middleware
+`webstack_django_sorting.middleware.SortingMiddleware` from `MIDDLEWARE_CLASSES` list.
 
 How to use it in your project
 ---------------------------------
 
-1. ``pip install webstack_django_sorting``
+1. `pip install webstack_django_sorting`
 
-2. Add the application to the ``INSTALLED_APPS`` list::
+2. Add the application to the `INSTALLED_APPS` list:
 
+    ```python
        INSTALLED_APPS = [
            # ...
            'webstack_django_sorting',
        ]
+    ```
 
-3. Check the request context processor is loaded in ``TEMPLATES`` options::
+3. Check the request context processor is loaded in `TEMPLATES` options:
 
+    ```python
        TEMPLATES = [
            {
                'BACKEND': 'django.template.backends.django.DjangoTemplates',
@@ -55,34 +58,39 @@ How to use it in your project
                },
            },
        ]
+    ```
 
-4. Add this line at the top of your template to load the sorting tags::
+4. Add this line at the top of your template to load the sorting tags:
 
        {% load sorting_tags %}
 
 5. Decide on a variable that you would like to sort, and use the
-   autosort tag on that variable before iterating over it::
+   autosort tag on that variable before iterating over it:
 
        {% autosort object_list %}
 
 6. Now, you want to display different headers with links to sort
-   your objects_list::
+   your objects_list:
 
+    ```html
        <tr>
            <th>{% anchor first_name _("Name") %}</th>
            <th>{% anchor creation_date _("Creation") %}</th>
        </tr>
+    ```
 
    The first argument is a field or an attribute of the objects list, and the
    second one (optional) is a title that would be displayed. The previous
-   snippet will be rendered like this in French::
+   snippet will be rendered like this in French:
 
+    ```html
         <tr>
             <th><a href="/path/to/your/view/?sort=first_name" title="Nom">Nom</a></th>
             <th><a href="/path/to/your/view/?sort=creation_date" title="Création">Création</a></th>
         </tr>
+    ```
 
    If your application doesn't support internationalization, you can use a
-   simple ``{% anchor first_name Name %}``.
+   simple `{% anchor first_name Name %}`.
 
 That's it!

setup.py

@@ -14,7 +14,7 @@
     name="webstack-django-sorting",
     version=__version__,
     description="Easy sorting of tables with Django",
-    long_description=codecs.open("README.rst", "r", "utf-8").read(),
+    long_description=codecs.open("README.md", "r", "utf-8").read(),
     author="Stéphane Raimbault",
     author_email="[email protected]",
     url="http://github.com/webstack/webstack-django-sorting/",