aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEllison Leão <ellisonleao@gmail.com>2021-02-24 11:38:07 -0300
committerEllison Leão <ellisonleao@gmail.com>2021-02-24 11:38:07 -0300
commit2f276d3461421974d861e95623ae653796f7ff4f (patch)
tree5222ba2e5890ab032df257c871da2eb572b72a8c /README.md
parentbe9a2c3c20ec760a12d85373ccfbc4fa4fe58c26 (diff)
parent33e0dfaba8944e428dfe55f68381c607d87dce9a (diff)
downloadgruvbox-2f276d3461421974d861e95623ae653796f7ff4f.tar.gz
gruvbox-2f276d3461421974d861e95623ae653796f7ff4f.tar.xz
Merge branch 'lush' into main
* lush: adding terminal_color_* #8 adding more plugin support changed gruvbox lua module namespace adding more highlight groups initial changes on moving to lush.nvim
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/README.md b/README.md
index 52228a8..9d7a6ae 100644
--- a/README.md
+++ b/README.md
@@ -2,43 +2,46 @@
A port of [gruvbox community](https://github.com/gruvbox-community/gruvbox) theme to lua with [treesitter](https://github.com/nvim-treesitter/nvim-treesitter) support!
-Please note that this plugin is under active development right now, so the status for it is still alpha.
+Please note that this plugin is under active development right now, so the status for it is still alpha. Please file issues if you find any bugs.
# Installing
Using `vim-plug`
```
-Plug 'tjdevries/colorbuddy.nvim' # required
+Plug 'rktjmp/lush.nvim' # required
Plug 'npxbr/gruvbox.nvim'
```
Using `packer`
```
-use {"npxbr/gruvbox.nvim", requires = {"tjdevries/colorbuddy.nvim"}}
+use {"npxbr/gruvbox.nvim", requires = {"rktjmp/lush.nvim"}}
```
# Usage
Inside `init.vim`
-```lua
-lua require("colorbuddy").colorscheme("gruvbox")
-
--- or
+```vimscript
+set background=dark " or light if you want light mode
+set colorscheme=gruvbox
+```
-lua require("colorbuddy").colorscheme("gruvbox", "light") -- for light mode
+```lua
+vim.o.background = "dark" -- or "light" for light mode
+vim.cmd([[ colorscheme gruvbox]])
```
# Configuration
all `g:gruvbox_` configs are the same [as the original one](https://github.com/morhetz/gruvbox/wiki/Configuration) except for `g:gruvbox_guisp_fallback`
-# Supported plugins
+# Additional supported plugins
- [vim-signify](https://github.com/mhinz/vim-signify)
- [vim-startify](https://github.com/mhinz/vim-startify)
-- [galaxyline.nvim](https://github.com/glepnir/galaxyline.nvim)
+- [lspsaga.nvim](https://github.com/glepnir/lspsaga.nvim)
+- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
More to be added..