75844fe1a1c9bfc84270b593cc0357fd1c356d87

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

Put relevant documentation into README file

Diff

 1diff --git a/plugins/taskwarrior/README.md b/plugins/taskwarrior/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..053151e78c98cdecfcabd1c2c46b7bec5b169eb1
 4--- /dev/null
 5+++ b/plugins/taskwarrior/README.md
 6@@ -0,0 +1,13 @@
 7+# taskwarrior
 8+
 9+This plugin adds smart tab completion for [TaskWarrior](http://taskwarrior.org/).
10+It uses the zsh tab completion script (`_task`) shipped with TaskWarrior for the
11+completion definitions.
12+
13+The latest version pulled in from the official project is of January 1st, 2015.
14+
15+
16+## Examples
17+
18+Typing `task [TAB]` will give you a list of commands, `task 66[TAB]` shows a
19+list of available modifications for that task, etcetera.
20diff --git a/plugins/taskwarrior/taskwarrior.plugin.zsh b/plugins/taskwarrior/taskwarrior.plugin.zsh
21index 5d1e6ffea23fabfa87ae3d3e2f81dd1082d85684..ab885943f14d72b569ecb8e38ebb8ade0d51d7d2 100644
22--- a/plugins/taskwarrior/taskwarrior.plugin.zsh
23+++ b/plugins/taskwarrior/taskwarrior.plugin.zsh
24@@ -1,17 +1,3 @@
25-################################################################################
26-# Author: Pete Clark
27-# Email: pete[dot]clark[at]gmail[dot]com
28-# Version: 0.1 (05/24/2011)
29-# License: WTFPL<http://sam.zoy.org/wtfpl/>
30-#
31-# This oh-my-zsh plugin adds smart tab completion for
32-# TaskWarrior<http://taskwarrior.org/>. It uses the zsh tab completion
33-# script (_task) distributed with TaskWarrior for the completion definitions.
34-#
35-# Typing task [tabtab] will give you a list of current tasks, task 66[tabtab]
36-# gives a list of available modifications for that task, etc.
37-################################################################################
38-
39 zstyle ':completion:*:*:task:*' verbose yes
40 zstyle ':completion:*:*:task:*:descriptions' format '%U%B%d%b%u'
41