Description

README.md

@@ -2,4 +2,57 @@
 
 [![Build Status](https://travis-ci.org/andreynovikov/django-daterangefilter.svg?branch=master)](https://travis-ci.org/andreynovikov/django-daterangefilter)
 [![GitHub release](https://img.shields.io/github/release/andreynovikov/django-daterangefilter.svg)](https://github.com/andreynovikov/django-daterangefilter/releases/latest)
+[![GitHub issues](https://img.shields.io/github/issues/andreynovikov/django-daterangefilter.svg)](https://github.com/andreynovikov/django-daterangefilter/issues)
 [![GitHub license](https://img.shields.io/github/license/andreynovikov/django-daterangefilter.svg)](LICENSE)
+
+Application adds three Django admin list filters: ```DateRangeFilter```, ```PastDateRangeFilter``` and ```FutureDateRangeFilter```. These filters let user filter models by date range. ```PastDateRangeFilter``` and ```FutureDateRangeFilter``` add quick selection of predefined date ranges. Filters can be applied to any model date fields. Application supports default Django admin theme and [Suit theme](https://github.com/darklow/django-suit).
+
+## Requirements
+
+* Python 2.7+ or Python 3.3+
+* Django 1.9+
+
+## Installation
+
+Clone repo into Django project root:
+
+```
+git clone https://github.com/andreynovikov/django-daterangefilter.git daterangefilter
+```
+
+Add ```daterangefilter``` to ```INSTALLED_APPS```. Example:
+
+```
+INSTALLED_APPS = (
+    ...
+    'daterangefilter',
+    ...
+)
+```
+
+Check that ```LANGUAGE_CODE``` is defined in project configuration.
+
+## Example usage
+
+in admin.py:
+
+```
+from django.contrib import admin
+from daterangefilter.filters import PastDateRangeFilter, FutureDateRangeFilter
+
+@admin.register(Post)
+class PostAdmin(admin.ModelAdmin):
+    list_filter = [
+        ('created_at', PastDateRangeFilter), ('publish_at', FutureDateRangeFilter)
+    ]
+```
+
+## Advanced usage
+
+Predefined ranges can be completely redefined by overriding ```_past_ranges.html``` and ```_future_ranges.html``` templates.
+Take into account that these templates are inserted in the middle of the javascript code and may contain nothing but ranges
+definition. For more examples on using ```moment``` library refer to [library documentation](https://momentjs.com/docs/#/manipulating/).
+
+## Credits
+
+Filter widget uses a great JavaScript date range picker component - [Date Range Picker](https://github.com/dangrossman/daterangepicker) by Dan Grossman.