浏览代码

Add README to tig plugin

Marc Cornellà 7 年之前
父节点
当前提交
04dd97783e
共有 2 个文件被更改,包括 16 次插入3 次删除
  1. 16 0
      plugins/tig/README.md
  2. 0 3
      plugins/tig/tig.plugin.zsh

+ 16 - 0
plugins/tig/README.md

@@ -0,0 +1,16 @@
+# `tig` plugin
+
+This plugin adds some aliases for people who work with `tig` in
+a regular basis. To use it, add `tig` to your plugins array:
+
+```zsh
+plugins=(... tig)
+```
+
+## Features
+
+| Alias | Command        | Description                                     |
+|-------|----------------|-------------------------------------------------|
+| `tis` | `tig status`   | Show git status                                 |
+| `til` | `tig log`      | Show git log                                    |
+| `tib` | `tig blame -C` | `git-blame` a file detecting copies and renames |

+ 0 - 3
plugins/tig/tig.plugin.zsh

@@ -1,6 +1,3 @@
 alias tis='tig status'
 alias til='tig log'
-
-# blame a single file and list commits
 alias tib='tig blame -C'
-