Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
agkozak committed Nov 27, 2018
1 parent 39fde83 commit 4c94fc3
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[![MIT License](img/mit_license.svg)](https://opensource.org/licenses/MIT)
[![GitHub tag](https://img.shields.io/github/tag/agkozak/agkozak-zsh-prompt.svg)](https://GitHub.com/agkozak/agkozak-zsh-prompt/tags/)
![zsh version 4.3.11 and higher](img/zsh_4.3.11_plus.svg)
[![GitHub Stars](https://img.shields.io/github/stars/agkozak/agkozak-zsh-prompt.svg)](https://github.com/agkozak/agkozak-zsh-prompt/stargazers)
![ZSH version 4.3.11 and higher](img/zsh_4.3.11_plus.svg)
[![GitHub stars](https://img.shields.io/github/stars/agkozak/agkozak-zsh-prompt.svg)](https://github.com/agkozak/agkozak-zsh-prompt/stargazers)

The agkozak ZSH Prompt is an asynchronous color Git prompt for ZSH that uses basic ASCII symbols to show:

Expand Down Expand Up @@ -195,15 +195,15 @@ If you prefer a single-line prompt with a right prompt that disappears when it i

in your `.zshrc`.

![Single-Line Prompt](img/single-line_prompt.gif)
![Single-line prompt](img/single-line_prompt.gif)

### Optional Left-prompt-only Mode

If you would like to have the Git status displayed in the left prompt (with no right prompt -- this is how [`pure`](https://github.com/sindresorhus/pure) does it), set

AGKOZAK_LEFT_PROMPT_ONLY=1

![Left-Prompt-Only Mode](img/AGKOZAK_LEFT_PROMPT_ONLY.gif)
![Left-prompt-only mode](img/AGKOZAK_LEFT_PROMPT_ONLY.gif)

### Custom Colors
If you would like to customize the prompt colors, change any of the `AGKOZAK_COLORS_*` variables from their defaults to any valid color and add it to your `.zshrc`. The following are the available color variables and their defaults:
Expand All @@ -213,7 +213,7 @@ If you would like to customize the prompt colors, change any of the `AGKOZAK_COL
AGKOZAK_COLORS_PATH=blue
AGKOZAK_COLORS_BRANCH_STATUS=yellow

![Custom Colors](img/colors.gif)
![Custom colors](img/colors.gif)

### Custom Prompts
If you would like to make further customizations to your prompt, you may use the variables `AGKOZAK_CUSTOM_PROMPT` and `AGKOZAK_CUSTOM_RPROMPT` to specify the exact strings to be used for the left and right prompts. The default prompts, with the default settings, are
Expand Down

0 comments on commit 4c94fc3

Please sign in to comment.