From 9b6257510cdbff28cc9b5486bf6b5cc57e2cbec8 Mon Sep 17 00:00:00 2001 From: Mike Smith <10135646+mikesmithgh@users.noreply.github.com> Date: Fri, 20 Dec 2024 21:34:24 -0500 Subject: [PATCH] docs: add installation instructions to README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index a3ca1c7..54c69ac 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,22 @@ sh -c "$(curl -s https://raw.githubusercontent.com/mikesmithgh/gruvsquirrel.nvim > [read the script](https://github.com/mikesmithgh/gruvsquirrel.nvim/blob/main/scripts/mini.sh) > before running `sh -c` directly from the web +## 📦 Installation + +Using [lazy.nvim](https://github.com/folke/lazy.nvim): + +```lua +{ + 'mikesmithgh/gruvsquirrel.nvim', + lazy = false, + priority = 1000, + config = function() + -- load colorscheme on startup + vim.cmd([[colorscheme gruvsquirrel]]) + end, +} +``` + ## 🤝 Ackowledgements - [gruvbox](https://github.com/morhetz/gruvbox) > Designed as a bright theme with pastel 'retro groove' colors and light/dark mode switching in the way of solarized. The main focus when developing gruvbox is to keep colors easily distinguishable, contrast enough and still pleasant for the eyes.