summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/taskwarrior/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'oh-my-zsh/plugins/taskwarrior/README.md')
-rw-r--r--oh-my-zsh/plugins/taskwarrior/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/taskwarrior/README.md b/oh-my-zsh/plugins/taskwarrior/README.md
new file mode 100644
index 0000000..e77e452
--- /dev/null
+++ b/oh-my-zsh/plugins/taskwarrior/README.md
@@ -0,0 +1,18 @@
+# taskwarrior
+
+This plugin adds smart tab completion for [TaskWarrior](https://taskwarrior.org/).
+It uses the zsh tab completion script (`_task`) shipped with TaskWarrior for the
+completion definitions.
+
+To use it, add `taskwarrior` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... taskwarrior)
+```
+
+## Examples
+
+Typing `task [TAB]` will give you a list of commands, `task 66[TAB]` shows a
+list of available modifications for that task, etcetera.
+
+The latest version pulled in from the official project is of January 1st, 2015.