Updated README

pull/15/head
Andrew Williams 2014-11-15 19:58:01 +00:00
parent 3db98d186f
commit 639950c5f5
1 changed files with 9 additions and 3 deletions

View File

@ -8,11 +8,17 @@ Any list that ends with `--` or `=` is treated specially, and processed by NextA
Note that NextAction requires Todoist Premium to function properly, as labels are a premium feature.
Requirements
============
* Python 2.6, Python 3.0+ is unsupported at the moment
* ```python-dateutil``` package.
Activating NextAction
======
=====================
Sequential list processing
------
--------------------------
If a list ends with `--`, the top level of tasks will be treated as a priority queue and the most important will be labeled `@next_action`.
Importance is determined by:
1. Priority
@ -22,7 +28,7 @@ Importance is determined by:
`@next_action` waterfalls into indented regions. If the top level task that is selected to receive the `@next_action` label has subtasks, the same algorithm is used. The `@next_action` label is only applied to one task.
Parallel list processing
------
------------------------
If a list name ends with `=`, the top level of tasks will be treated as parallel `@next_action`s.
The waterfall processing will be applied the same way as sequential lists - every parent task will be treated as sequential. This can be overridden by appending `=` to the name of the parent task.