From f7e87cf5dee32dad43b87439eb427b1dda58416e Mon Sep 17 00:00:00 2001 From: Mike <10135646+mikesmithgh@users.noreply.github.com> Date: Fri, 20 Dec 2024 21:35:52 -0500 Subject: [PATCH] docs: add installation instructions to README (#99) --- README.md | 16 ++++++++++++++++ doc/gruvsquirrel.nvim.txt | 20 +++++++++++++++++++- 2 files changed, 35 insertions(+), 1 deletion(-) 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. diff --git a/doc/gruvsquirrel.nvim.txt b/doc/gruvsquirrel.nvim.txt index 0afccc7..5dda815 100644 --- a/doc/gruvsquirrel.nvim.txt +++ b/doc/gruvsquirrel.nvim.txt @@ -1,10 +1,11 @@ -*gruvsquirrel.nvim.txt* For NVIM nightly Last change: 2023 July 23 +*gruvsquirrel.nvim.txt* For NVIM nightly Last change: 2024 December 21 ============================================================================== Table of Contents *gruvsquirrel.nvim-table-of-contents* 1. gruvsquirrel.nvim |gruvsquirrel.nvim-gruvsquirrel.nvim| - Quickstart |gruvsquirrel.nvim-gruvsquirrel.nvim-quickstart| + - Installation |gruvsquirrel.nvim-gruvsquirrel.nvim-installation| - Ackowledgements |gruvsquirrel.nvim-gruvsquirrel.nvim-ackowledgements| @@ -32,6 +33,23 @@ command: before running `sh -c` directly from the web +INSTALLATION *gruvsquirrel.nvim-gruvsquirrel.nvim-installation* + +Using lazy.nvim + +>lua + { + 'mikesmithgh/gruvsquirrel.nvim', + lazy = false, + priority = 1000, + config = function() + -- load colorscheme on startup + vim.cmd([[colorscheme gruvsquirrel]]) + end, + } +< + + ACKOWLEDGEMENTS *gruvsquirrel.nvim-gruvsquirrel.nvim-ackowledgements* - gruvbox