summaryrefslogtreecommitdiff
path: root/plugins/tig
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2016-08-24 21:27:18 +0200
committerMarc Cornellà <marc.cornella@live.com>2016-08-24 21:28:49 +0200
commit04dd97783e251c795314c6fca70b14062274ff9b (patch)
tree9f9a987535bfbc96d8a919abb771f15ceb2518cb /plugins/tig
parentbf79e1ceac3e9f850b3818009625826e8587be98 (diff)
downloadzsh-04dd97783e251c795314c6fca70b14062274ff9b.tar.gz
zsh-04dd97783e251c795314c6fca70b14062274ff9b.tar.bz2
zsh-04dd97783e251c795314c6fca70b14062274ff9b.zip
Add README to tig plugin
Diffstat (limited to 'plugins/tig')
-rw-r--r--plugins/tig/README.md16
-rw-r--r--plugins/tig/tig.plugin.zsh3
2 files changed, 16 insertions, 3 deletions
diff --git a/plugins/tig/README.md b/plugins/tig/README.md
new file mode 100644
index 000000000..bb24cd147
--- /dev/null
+++ b/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 |
diff --git a/plugins/tig/tig.plugin.zsh b/plugins/tig/tig.plugin.zsh
index 1d2a4d5c9..7e0c530ac 100644
--- a/plugins/tig/tig.plugin.zsh
+++ b/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'
-