From 452414cafb926d6fcd7fe1a41fdbffbf6e2ce99b Mon Sep 17 00:00:00 2001 From: Squibid Date: Thu, 24 Apr 2025 14:40:13 -0500 Subject: [PATCH] update the README with more relevant information --- README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 3c73386..f7865f9 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,13 @@ liking. 2. `declarative` - packages are declared using simple Lua tables. 3. `correct` - packages are always loaded in a correct and consistent order. -See also squibid's [neovim-configs][11] for an example of how dep can be used in +See also squibid's [neovim-configs][10] for an example of how dep can be used in practice. ## Requirements -- [Neovim][2] 0.6+ -> Needs checking not sure which version this requires -- [Git][6] +- [Neovim][2] 0.8+ +- [Git][6] 2.13+ ## Setup @@ -28,11 +27,11 @@ practice. ```lua -- ~/.config/nvim/lua/bootstrap.lua: --- automatically install `chiyadev/dep` on startup +-- automatically install `squibid/dep` on startup local path = vim.fn.stdpath("data") .. "/site/pack/deps/opt/dep" if vim.fn.empty(vim.fn.glob(path)) > 0 then - vim.fn.system({ "git", "clone", "--depth=1", "https://github.com/chiyadev/dep", path }) + vim.fn.system({ "git", "clone", "--depth=1", "https://git.squi.bid/dep", path }) end vim.cmd("packadd dep") @@ -65,16 +64,16 @@ A package must be declared in the following format. -- This is the only required field; all other fields are optional. "user/package", - -- [function] Code to run after the package is loaded into neovim. - load = function() - require "package".setup(...) - end, - -- [function] Code to run before the package is loaded into neovim. setup = function() vim.g.package_config = ... end, + -- [function] Code to run after the package is loaded into neovim. + load = function() + require "package".setup(...) + end, + -- [function] Code to run after the package is installed or updated. config = function() os.execute(...) @@ -421,5 +420,4 @@ dep is licensed under the [MIT License](LICENSE). [7]: https://github.com/nvim-telescope/telescope.nvim [8]: https://github.com/tpope/vim-fugitive [9]: https://GitHub.com/chiyadev/dep/issues -[10]: https://github.com/chiyadev/dep/graphs/contributors -[11]: https://git.squi.bid/nvim +[10]: https://git.squi.bid/nvim