summaryrefslogtreecommitdiff
path: root/plugins/branch/README.md
diff options
context:
space:
mode:
authorVictor Torres <vpaivatorres@gmail.com>2015-10-02 23:16:56 -0300
committerVictor Torres <vpaivatorres@gmail.com>2015-10-02 23:16:56 -0300
commitd49cacfb7bb96049185c2edfaf3c330b0bde338e (patch)
tree48e149d31a2748802c1f3f4580ad7e0638fa13ba /plugins/branch/README.md
parenta9c882094dedfdefb311db5967b974980cec49ec (diff)
downloadzsh-d49cacfb7bb96049185c2edfaf3c330b0bde338e.tar.gz
zsh-d49cacfb7bb96049185c2edfaf3c330b0bde338e.tar.bz2
zsh-d49cacfb7bb96049185c2edfaf3c330b0bde338e.zip
Add branch plugin
Diffstat (limited to 'plugins/branch/README.md')
-rw-r--r--plugins/branch/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/plugins/branch/README.md b/plugins/branch/README.md
new file mode 100644
index 000000000..f970266a8
--- /dev/null
+++ b/plugins/branch/README.md
@@ -0,0 +1,33 @@
+# Branch
+
+Displays the current Git or Mercurial branch fast.
+
+## Speed test
+
+### Mercurial
+
+```shell
+$ time hg branch
+0.11s user 0.14s system 70% cpu 0.355 total
+```
+
+### Branch plugin
+
+```shell
+$ time sh /tmp/branch_prompt_info.sh
+0.01s user 0.01s system 81% cpu 0.018 total
+```
+
+## Usage
+
+Edit your theme file (eg.: `~/.oh-my-zsh/theme/robbyrussell.zsh-theme`)
+adding `$(branch_prompt_info)` in your prompt like this:
+
+```diff
+- PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}'
++ PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)$(branch_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}'
+```
+
+## Maintainer
+
+Victor Torres (<vpaivatorres@gmail.com>)