From: Rob Golding <rob@robgolding.com>
Date: Sun, 14 Apr 2013 20:31:12 +0000 (+0100)
Subject: Update docs to reflect new API
X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/commitdiff_plain/804022a199150d97c2b06c0821883d3e8d691a49?hp=86e0329a1e477c8bb59eb033cc7a8f821067b426

Update docs to reflect new API
---

diff --git a/README.rst b/README.rst
index 6cf60d6..28a61fb 100644
--- a/README.rst
+++ b/README.rst
@@ -20,15 +20,30 @@ Usage
 
 .. source-code:
 
-    >>> from tasklib.task import TaskWarrior, PENDING
+    >>> from tasklib.task import TaskWarrior
 
     >>> tw = TaskWarrior('/home/rob/.task')
-    >>> tasks = tw.get_tasks(status=PENDING)
+    >>> tasks = tw.tasks.pending()
     >>> tasks
     ['Tidy the house', 'Learn German']
+    >>> tasks.filter(tags__contain='chores')
+    ['Tidy the house']
     >>> type(tasks[0])
     <class 'tasklib.task.Task'>
     >>> task[0].done()
 
+Filtering Tasks
+---------------
+
+Tasks can be filtered using the ``TaskQuerySet`` API which emulates the
+Django ORM::
+
+    >>> tw.tasks.filter(status='pending', tags__contain='work')
+    ['Upgrade Ubuntu Server']
+
+Filter arguments are passed to the ``task`` command (``__`` is replaced by
+a period); so the above example is equivalent to the following command::
+
+    $ task status:pending tags.contain=work
 
 .. _taskwarrior: http://taskwarrior.org