From 474868439090f647aa869ecf0b4753cfa8e60d5b Mon Sep 17 00:00:00 2001
From: Karl Hobley <karl@torchbox.com>
Date: Wed, 9 Jul 2014 15:43:07 +0100
Subject: [PATCH] Added basic useage docs for python developers

---
 docs/wagtailsearch/for_python_developers.rst | 21 ++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/docs/wagtailsearch/for_python_developers.rst b/docs/wagtailsearch/for_python_developers.rst
index d183bfe318..548510f6f0 100644
--- a/docs/wagtailsearch/for_python_developers.rst
+++ b/docs/wagtailsearch/for_python_developers.rst
@@ -7,6 +7,27 @@ Wagtailsearch: For python developers
 ====================================
 
 
+Basic useage
+============
+
+All searches are performed on Django QuerySets:
+
+.. code-block:: python
+
+    # Search future EventPages
+    >>> from wagtail.wagtailcore.models import EventPage
+    EventPage.objects.filter(date__gt=timezone.now()).search("Hello world!")
+
+
+All methods of ``PageQuerySet`` are supported by wagtailsearch:
+
+.. code-block:: python
+
+    # Search all live EventPages that are under the events index
+    >>> EventPage.objects.live().descendant_of(events_index).search("Hello")
+    [<EventPage: Event 1>, <EventPage: Event 2>]
+
+
 Indexing extra fields
 =====================