From 92d8f8b9eefe996fe3ce1af0592c08545073e646 Mon Sep 17 00:00:00 2001 From: Squibid Date: Tue, 24 Dec 2024 14:28:16 -0500 Subject: update readme --- README.md | 37 +++++++++++-------------------------- 1 file changed, 11 insertions(+), 26 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d3991af..73831e0 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,8 @@ # dep - -[![License](https://img.shields.io/github/license/chiyadev/dep)](LICENSE) -[![Maintainer](https://img.shields.io/badge/maintainer-luaneko-pink)][4] -[![Issues](https://img.shields.io/github/issues/chiyadev/dep.svg)][8] -[![Contributors](https://img.shields.io/github/contributors/chiyadev/dep.svg)][9] - > This readme is a work in progress. -A versatile, declarative and correct [neovim][2] package manager in [Lua][3]. -Originally written for personal use by [luaneko][4]. +A versatile, declarative and correct [neovim][1] package manager in [Lua][2]. +Originally written for personal use by [luaneko][3]. What does that mean? @@ -16,20 +10,16 @@ What does that mean? 2. `declarative` - packages are declared using simple Lua tables. 3. `correct` - packages are always loaded in a correct and consistent order. -See also luaneko's [neovim-configs][10] for an example of how dep can be used in practice. - +See also squibid's [neovim-configs][5] for an example of how dep can be used in practice. ## Requirements - -- [Neovim][2] 0.6+ -- [Git][5] - +- [Neovim][1] 0.6+ +- [Git][4] ## Setup - 1. Create `lua/bootstrap.lua` in your neovim config directory. ```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 @@ -316,13 +306,8 @@ require "dep" { dep is licensed under the [MIT License](LICENSE). -[1]: https://chiya.dev/posts/2021-11-27-why-package-manager -[2]: https://neovim.io/ -[3]: https://www.lua.org/ -[4]: https://github.com/luaneko -[5]: https://git-scm.com/ -[6]: https://github.com/nvim-telescope/telescope.nvim -[7]: https://github.com/tpope/vim-fugitive -[8]: https://GitHub.com/chiyadev/dep/issues -[9]: https://github.com/chiyadev/dep/graphs/contributors -[10]: https://github.com/luaneko/neovim-config +[1]: https://neovim.io/ +[2]: https://www.lua.org/ +[3]: https://github.com/luaneko +[4]: https://git-scm.com/ +[5]: https://git.squi.bid/nvim -- cgit v1.2.1