Added README.MD

README.MD

@@ -0,0 +1,66 @@
+## Synopsis
+
+__django-pagination__ allows for easy Digg-style pagination without modifying
+your views.
+
+## Code Example
+
+Add this line at the top of your template to load the pagination tags:
+
+    {% load pagination_tags %}
+
+Decide on a variable that you would like to paginate, and use the autopaginate tag on that variable before iterating over it.  This could take one of two forms (using the canonical `object_list` as an example variable):
+
+    {% autopaginate object_list %}       
+
+This assumes that you would like to have the default 20 results per page. If you would like to specify your own amount of results per page, you can specify that like so:
+
+    {% autopaginate object_list 10 %}
+
+Note that this replaces `object_list` with the list for the current page, so you can iterate over the ``object_list`` like you normally would.   
+
+Now you want to display the current page and the available pages, so somewhere after having used autopaginate, use the paginate inclusion tag:
+
+    {% paginate %}
+
+This does not take any arguments, but does assume that you have already called autopaginate, so make sure to do so first.
+
+
+## Installation
+
+Full Details under __docs/install.txt__.
+
+Install library via pip:
+
+    pip install django-pagination
+
+List this application in the ``INSTALLED_APPS`` portion of your settings file.  Your settings file might look something like::
+
+       INSTALLED_APPS = (
+           # ...
+           'pagination',
+       )
+
+
+Install the pagination middleware.  Your settings file might look something like:
+
+       MIDDLEWARE_CLASSES = (
+           # ...
+           'pagination.middleware.PaginationMiddleware',
+       )
+
+If it's not already added in your setup, add the request context processor. Note that context processors are set by default implicitly, so to set them explicitly, you need to copy and paste this code into your under the value __TEMPLATE_CONTEXT_PROCESSORS__
+
+        ("django.core.context_processors.auth",
+        "django.core.context_processors.debug",
+        "django.core.context_processors.i18n",
+        "django.core.context_processors.media",
+        "django.core.context_processors.request")
+
+## Contributors
+
+See __CONTRIBUTORS.txt__
+
+## License
+
+See __LICENSE.txt__