# vim-gitbranch

**Repository Path**: hello-luiswu/vim-gitbranch

## Basic Information

- **Project Name**: vim-gitbranch
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-08
- **Last Updated**: 2025-08-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vim-gitbranch
## Usage
This plugin provides a function which returns the name of the git branch.
```vim
:echo gitbranch#name()
```

You can use this function to integrate with statusline plugins.

For example, in order to show git branch using [lightline.vim](https://github.com/itchyny/lightline.vim), configure as follows.
```vim
let g:lightline = {
      \ 'active': {
      \   'left': [ [ 'mode', 'paste' ],
      \             [ 'gitbranch', 'readonly', 'filename', 'modified' ] ]
      \ },
      \ 'component_function': {
      \   'gitbranch': 'gitbranch#name'
      \ },
      \ }
```
See the [README.md of lightline](https://github.com/itchyny/lightline.vim) for further details.

## Installation
Install with your favorite plugin manager.

## Author
itchyny (https://github.com/itchyny)

## License
This software is released under the MIT License, see LICENSE.