summaryrefslogtreecommitdiff
path: root/plugins/taskwarrior/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2015-08-10 01:45:11 +0200
committerMarc Cornellà <marc.cornella@live.com>2015-09-05 22:47:51 +0200
commit75844fe1a1c9bfc84270b593cc0357fd1c356d87 (patch)
tree4b10c1fdaf6f21fd58b2cc60f22596115a331300 /plugins/taskwarrior/README.md
parent9c08641d7c2aae0c82fa5ad91f94c67b70115ba5 (diff)
downloadzsh-75844fe1a1c9bfc84270b593cc0357fd1c356d87.tar.gz
zsh-75844fe1a1c9bfc84270b593cc0357fd1c356d87.tar.bz2
zsh-75844fe1a1c9bfc84270b593cc0357fd1c356d87.zip
Put relevant documentation into README file
Diffstat (limited to 'plugins/taskwarrior/README.md')
-rw-r--r--plugins/taskwarrior/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/plugins/taskwarrior/README.md b/plugins/taskwarrior/README.md
new file mode 100644
index 000000000..053151e78
--- /dev/null
+++ b/plugins/taskwarrior/README.md
@@ -0,0 +1,13 @@
+# taskwarrior
+
+This plugin adds smart tab completion for [TaskWarrior](http://taskwarrior.org/).
+It uses the zsh tab completion script (`_task`) shipped with TaskWarrior for the
+completion definitions.
+
+The latest version pulled in from the official project is of January 1st, 2015.
+
+
+## Examples
+
+Typing `task [TAB]` will give you a list of commands, `task 66[TAB]` shows a
+list of available modifications for that task, etcetera.