diff --git a/README.md b/README.md index 54ffa63..bb0876e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ # incline.nvim [![Version v0.0.3](https://img.shields.io/github/v/tag/b0o/incline.nvim?style=flat&color=yellow&label=version&sort=semver)](https://github.com/b0o/incline.nvim/releases) [![License: MIT](https://img.shields.io/github/license/b0o/incline.nvim?style=flat&color=green)](https://mit-license.org) [![Test Status](https://img.shields.io/github/actions/workflow/status/b0o/incline.nvim/test.yaml?branch=main&label=tests)](https://github.com/b0o/incline.nvim/actions/workflows/test.yaml) -Incline is a plugin for creating lightweight floating statuslines. It's best used with Neovim's global statusline (`set laststatus=3`). +Incline is a plugin for creating lightweight floating statuslines. It's best used with Neovim's global statusline (`set laststatus=3`). + +Why use Incline instead of Neovim's built-in winbar? Incline: + +- Takes up only the amount of space it needs, leaving the rest of the line available for your code. +- Is highly configurable and themeable using Lua. +- Can be shown/hidden dynamically based on cursor position, focus, buffer type, or any other condition you want. +- Can be positioned anywhere you want. +- Can even be used in combination with a bufferline, if you really want! ![Screenshot of Incline.nvim running in Neovim](https://user-images.githubusercontent.com/21299126/167235114-d562ea45-155c-4d82-aaf1-95abb56398b7.png)