1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index 281a295..6c945ce 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,31 @@
 # gruvbox.nvim
+
+A port of [gruvbox](https://github.com/morhetz/gruvbox) theme to lua.
+
+Please not this plugin in active development right now, so the status for it is still
+alpha.
+
+# Installing
+
+Using `vim-plug`
+
+```
+Plug 'tjdevries/colorbuddy.nvim' # required
+Plug 'npxbr/gruvbox.nvim'
+```
+
+# Usage
+
+Inside `init.vim`
+
+```lua
+lua require("colorbuddy").colorscheme("gruvbox")
+
+or
+
+lua require("colorbuddy").colorscheme("gruvbox", "light") -- for light mode
+```
+
+# 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`