summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorElijah Manor <elijah.manor@gmail.com>2022-11-21 06:47:24 -0600
committerGitHub <noreply@github.com>2022-11-21 07:47:24 -0500
commite80aa6667166334119d567567e7d1e1eed3ae2fb (patch)
tree19dd83f5353c3d71018826c49fbdd339fff70b59 /README.md
parente311d48c97f00d526b266c9d67c4a120eba622f7 (diff)
Add optional packer plugins hook (#20)
* Add optional packer plugins hook * Provide help in README and simplify module * Fix spelling and tweak verbiage about after/plugin
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
index 61b559a..e5f8075 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,37 @@ This repo is meant to be used as a starting point for a user's own configuration
* Start Neovim (`nvim`) and run `:PackerInstall` - ignore any error message about missing plugins, `:PackerInstall` will fix that shortly
* Restart Neovim
+### Configuration
+
+You could directly modify the `init.lua` file with your personal customizations. This option is the most straightforward, but if you update your config from this repo, you may need to reapply your changes.
+
+An alternative approach is to create a separate `custom.plugins` module to register your own plugins. In addition, you can handle further customizations in the `/after/plugin/` directory (see `:help load-plugins`). See the following examples for more information. Leveraging this technique should make upgrading to a newer version of this repo easier.
+
+#### Example `plugins.lua`
+
+The following is an example of a `plugins.lua` module (located at `$HOME/.config/nvim/lua/custom/plugins.lua`) where you can register your own plugins.
+
+```lua
+return function(use)
+ use({
+ "folke/which-key.nvim",
+ config = function()
+ require("which-key").setup({})
+ end
+ })
+end
+```
+
+#### Example `defaults.lua`
+
+For further customizations, you can add a file in the `/after/plugin/` folder (see `:help load-plugins`) to include your own options, keymaps, autogroups, and more. The following is an example `defaults.lua` file (located at `$HOME/.config/nvim/after/plugin/defaults.lua`).
+
+```lua
+vim.opt.relativenumber = true
+
+vim.keymap.set('n', '<leader>sr', require('telescope.builtin').resume, { desc = '[S]earch [R]esume' })
+```
+
### Contribution
Pull-requests are welcome. The goal of this repo is not to create a Neovim configuration framework, but to offer a starting template that shows, by example, available features in Neovim. Some things that will not be included: