Merge pull request #8 from rose-pine/docs-add-supported-plugins

add lualine setup and supported plugins
This commit is contained in:
not 2021-08-13 21:00:07 -05:00 committed by GitHub
commit 510d3f3545
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -11,20 +11,22 @@
</a>
</p>
## Usage
## Install
1. Install via your preferred package manager
Install via your preferred package manager
```lua
-- Packer
use({ 'rose-pine/neovim', as = 'rose-pine' })
```
2. Require or set `rose-pine` colorscheme
## Usage
Enable `rose-pine` colorscheme
```lua
-- Lua
require('rose-pine').set()
vim.cmd('colorscheme rose-pine')
```
```vim
@ -32,6 +34,29 @@ require('rose-pine').set()
colorscheme rose-pine
```
Enable [lualine](https://github.com/hoob3rt/lualine.nvim) plugin
```lua
-- Lua
require('lualine').setup({
options = {
theme = 'rose-pine'
}
})
```
## Plugin Support
- [Treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
- [LSP diagnostics](https://neovim.io/doc/user/lsp.html)
- [Barbar](https://github.com/romgrk/barbar.nvim)
- [Gitsigns](https://github.com/lewis6991/gitsigns.nvim)
- [Modes](https://github.com/mvllow/modes.nvim)
- [NvimTree](https://github.com/kyazdani42/nvim-tree.lua)
- [WhichKey](https://github.com/folke/which-key.nvim)
- [Todo Comments](https://github.com/folke/todo-comments.nvim)
- [Lualine](https://github.com/hoob3rt/lualine.nvim)
## Gallery
**Rosé Pine**