From 42b7810ab6ce15659dbaf5b9b08bdb1c058227ff Mon Sep 17 00:00:00 2001 From: Adam Kramer Date: Sun, 9 Mar 2014 21:09:57 -0700 Subject: [PATCH] Updated license and took a first stab at preliminary documentation. --- LICENSE | 4 ++-- README.md | 23 ++++++++++++++++++++++- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/LICENSE b/LICENSE index ed89ab5..495c706 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2014 akramer +Copyright (c) 2014 Adam Kramer Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +SOFTWARE. diff --git a/README.md b/README.md index d9fde4a..f3e0c5e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,25 @@ NextAction ========== -A more GTD-like workflow for Todoist. Uses the REST API to add and remove a @next_action label from tasks. +A more GTD-like workflow for Todoist. Uses the REST API to add and remove a `@next_action` label from tasks. + +This program looks at every list in your Todoist account. +Any list that ends with `--` or `=` is treated specially, and processed by NextAction. + +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: + * Priority + * Due date + * Order in the list + +`@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.