# Git Status Plugin

A zsh plugin that exposes functions for retrieving informations about the
status of the current git repository.

After the `zsh-git-status.zsg` file is sourced a number of utilities functions
for getting informations about the git directories are avaible to the client
code.

## Prompt Application

A use case for this plugin is the displaying of the repository git status in
the terminal prompt.

The API function `get_git_status` returns a formatted
string which can be readily embedded inside a console prompt. For example:
`PROMPT='$(get_git_status)'`

One could either custumise the output of `get_git_status` by editing the global
variables defined in the `zsh-git-status-globals.zsh`, or use the API functions
to build their own prompt string.

The default formatted string shows the git info in the following format:
"[git branch|number of untracked|number of modified|number of conflicts|number of ahead commits]"