Skip to content

Commit d2d6654

Browse files
committed
Tweak README.rst
1 parent e7764ba commit d2d6654

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1-
How to use webstack-django-sorting
2-
----------------------------------
1+
webstack-django-sorting
2+
=======================
33

4-
``webstack-django-sorting`` allows for easy sorting, and sorting links
5-
generation without modifying your views. It is the perfect companion of
6-
`django-pagination <https://github.com/zyga/django-pagination>`_.
4+
``webstack-django-sorting`` allows for easy sorting of data tables and it
5+
provides sorting links for table headers. It is the perfect
6+
companion of `django-pagination <https://github.com/zyga/django-pagination>`_.
7+
8+
A demonstration of the features is provided in `testproj` directory.
79

810
To upgrade to ``webstack-django-sorting`` v1.0.0+, you must remove the old middleware
911
``webstack_django_sorting.middleware.SortingMiddleware`` from ``MIDDLEWARE_CLASSES`` list.
1012

13+
How to install it in your project
14+
---------------------------------
15+
1116
The 5 steps to use ``webstack-django-sorting`` in your Django project:
1217

1318
1. Add the application to the ``INSTALLED_APPS`` list::

0 commit comments

Comments
 (0)