summaryrefslogtreecommitdiff
path: root/plugins/branch/README.md
blob: 56ab8da4b4c8e1a1989c6d03c28138260e3c73f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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 zsh /tmp/branch_prompt_info_test.zsh
0.00s user 0.01s system 78% cpu 0.014 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>)