Add taskwarrior 2.3.0 beta2 to supported versions

[etc/taskwarrior.git] / README.rst

diff --git a/README.rst b/README.rst
index 6cf60d6daf3a02b86708864baa6f726264e595db..23de1192c1d7e960a1c1923e35aff2c0b73b7510 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,12 +1,19 @@
 tasklib
 =======
 
-A Python library for interacting with taskwarrior_ databases.
+.. image:: https://travis-ci.org/robgolding63/tasklib.png
+    :target: http://travis-ci.org/robgolding63/tasklib
+
+A Python library for interacting with taskwarrior_ databases, using a queryset
+API similar to that of Django's ORM.
+
+Supports Python 2.6, 2.7, 3.2 and 3.3 with taskwarrior 2.2.0 or 2.3.0 beta2.
+Older versions of taskwarrior are untested and probably won't work.
 
 Requirements
 ------------
 
-Before installing ``tasklib``, you'll need to install taskwarrior_.
+* taskwarrior_ v2.2.0 or v2.3.0 beta2
 
 Installation
 ------------
@@ -18,17 +25,23 @@ Install via pip::
 Usage
 -----
 
-.. source-code:
+tasklib has a similar API to that of Django's ORM::
 
-    >>> 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()
-
+    >>> tasks = tw.tasks.pending()
+    >>> tasks
+    ['Learn German']
+    >>> tasks[0]['tags'] = ['languages']
+    >>> tasks[0].save()
 
 .. _taskwarrior: http://taskwarrior.org