Commits

Luke Plant committed f867586

Added information about the example code available in the source.

Comments (0)

Files changed (1)

docs/overview.rst

 Customisation of the filters can be done in various ways - see :doc:`the
 FilterSet documentation <filterset>` for how to do this, and :doc:`the Filters
 documentation <filters>` for options that can be specified.
+
+
+Example
+-------
+
+A full example can be found in ``django_easyfilters/tests`` which is included in
+the source distribution. See the ``books`` view in ``views.py``:
+
+https://bitbucket.org/spookylukey/django-easyfilters/src/default/django_easyfilters/tests/views.py
+
+The ``book_search`` view gives an example of how to integrate with other searching and filtering. Remember to check the templates:
+
+https://bitbucket.org/spookylukey/django-easyfilters/src/default/django_easyfilters/tests/templates/
+
+See the :doc:`development <develop>` documentation if you want to run this
+example code as a demo.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.