Browse Source

Put relevant documentation into README file

Marc Cornellà 8 years ago
parent
commit
75844fe1a1
2 changed files with 13 additions and 14 deletions
  1. 13 0
      plugins/taskwarrior/README.md
  2. 0 14
      plugins/taskwarrior/taskwarrior.plugin.zsh

+ 13 - 0
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.

+ 0 - 14
plugins/taskwarrior/taskwarrior.plugin.zsh

@@ -1,17 +1,3 @@
-################################################################################
-# Author: Pete Clark
-# Email: pete[dot]clark[at]gmail[dot]com
-# Version: 0.1 (05/24/2011)
-# License: WTFPL<http://sam.zoy.org/wtfpl/>
-#
-# This oh-my-zsh plugin adds smart tab completion for
-# TaskWarrior<http://taskwarrior.org/>. It uses the zsh tab completion
-# script (_task) distributed with TaskWarrior for the completion definitions.
-#
-# Typing task [tabtab] will give you a list of current tasks, task 66[tabtab]
-# gives a list of available modifications for that task, etc.
-################################################################################
-
 zstyle ':completion:*:*:task:*' verbose yes
 zstyle ':completion:*:*:task:*:descriptions' format '%U%B%d%b%u'