]> git.madduck.net Git - etc/taskwarrior.git/blobdiff - README.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge pull request #65 from huntrar/develop
[etc/taskwarrior.git] / README.rst
index c8053ef90574233ed011e79060d01e428e54cdac..731241c43a4536f884fdf71591235ad4de7f4e40 100644 (file)
@@ -1,19 +1,22 @@
 tasklib
 =======
 
-.. image:: https://travis-ci.org/robgolding63/tasklib.png
+.. image:: https://travis-ci.org/robgolding63/tasklib.png?branch=develop
     :target: http://travis-ci.org/robgolding63/tasklib
 
+.. image:: https://coveralls.io/repos/robgolding63/tasklib/badge.png?branch=develop
+    :target: https://coveralls.io/r/robgolding63/tasklib?branch=develop
+
 tasklib is 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, 3.3 and 3.4 with taskwarrior 2.1.x and 2.2.x.
+Supports Python 2.6, 2.7, 3.2, 3.3 and 3.4 with taskwarrior 2.1.x and above.
 Older versions of taskwarrior are untested and may not work.
 
 Requirements
 ------------
 
-* taskwarrior_ v2.1.x or v2.2.x
+* taskwarrior_ v2.1.x or above.
 
 Installation
 ------------
@@ -27,7 +30,7 @@ Usage
 
 tasklib has a similar API to that of Django's ORM::
 
-    >>> from tasklib.task import TaskWarrior
+    >>> from tasklib import TaskWarrior
 
     >>> tw = TaskWarrior('/home/rob/.task')
     >>> tasks = tw.tasks.pending()
@@ -37,7 +40,7 @@ tasklib has a similar API to that of Django's ORM::
     ['Tidy the house']
     >>> type(tasks[0])
     <class 'tasklib.task.Task'>
-    >>> task[0].done()
+    >>> tasks[0].done()
     >>> tasks = tw.tasks.pending()
     >>> tasks
     ['Learn German']