Diff
1diff --git a/plugins/git-prompt/README.md b/plugins/git-prompt/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..e3b2d623a53a64c27bd90a9434c03b2f8f2d80b1
4--- /dev/null
5+++ b/plugins/git-prompt/README.md
6@@ -0,0 +1,61 @@
7+# git-prompt plugin
8+
9+A `zsh` prompt that displays information about the current git repository. In particular:
10+the branch name, difference with remote branch, number of files staged or changed, etc.
11+
12+To use it, add `git-prompt` to the plugins array in your zshrc file:
13+
14+```zsh
15+plugins=(... git-prompt)
16+```
17+
18+See the [original repository](https://github.com/olivierverdier/zsh-git-prompt).
19+
20+## Examples
21+
22+The prompt may look like the following:
23+
24+- `(master↑3|✚1)`: on branch `master`, ahead of remote by 3 commits, 1 file changed but not staged
25+- `(status|●2)`: on branch `status`, 2 files staged
26+- `(master|✚7…)`: on branch `master`, 7 files changed, some files untracked
27+- `(master|✖2✚3)`: on branch `master`, 2 conflicts, 3 files changed
28+- `(experimental↓2↑3|✔)`: on branch `experimental`; your branch has diverged by 3 commits, remote by 2 commits; the repository is otherwise clean
29+- `(:70c2952|✔)`: not on any branch; parent commit has hash `70c2952`; the repository is otherwise clean
30+
31+## Prompt Structure
32+
33+By default, the general appearance of the prompt is:
34+
35+```
36+(<branch><branch tracking>|<local status>)
37+```
38+
39+The symbols are as follows:
40+
41+### Local Status Symbols
42+
43+| Symbol | Meaning |
44+|--------|--------------------------------|
45+| ✔ | repository clean |
46+| ●n | there are `n` staged files |
47+| ✖n | there are `n` unmerged files |
48+| ✚n | there are `n` unstaged files |
49+| … | there are some untracked files |
50+
51+### Branch Tracking Symbols
52+
53+| Symbol | Meaning |
54+|--------|---------------------------------------------------------------|
55+| ↑n | ahead of remote by `n` commits |
56+| ↓n | behind remote by `n` commits |
57+| ↓m↑n | branches diverged: other by `m` commits, yours by `n` commits |
58+
59+## Customisation
60+
61+- Set the variable `ZSH_THEME_GIT_PROMPT_CACHE` to any value in order to enable caching.
62+- You may also change a number of variables (whose name start with `ZSH_THEME_GIT_PROMPT_`)
63+ to change the appearance of the prompt. Take a look at the bottom of the [plugin file](git-prompt.plugin.zsh)`
64+ to see what variables are available.
65+
66+
67+**Enjoy!**
68diff --git a/plugins/git-prompt/git-prompt.plugin.zsh b/plugins/git-prompt/git-prompt.plugin.zsh
69index 2776f297fc9d3f828c35426e4f0a6d0b8148d898..76ac2e62b00fde67fe5f1c967dc15a55304084b1 100644
70--- a/plugins/git-prompt/git-prompt.plugin.zsh
71+++ b/plugins/git-prompt/git-prompt.plugin.zsh
72@@ -1,6 +1,3 @@
73-# ZSH Git Prompt Plugin from:
74-# https://github.com/olivierverdier/zsh-git-prompt
75-
76 __GIT_PROMPT_DIR="${0:A:h}"
77
78 ## Hook function definitions