diff --git a/.github/workflows/luarocks.yml b/.github/workflows/luarocks.yml index c688e4e..6a7ce9e 100644 --- a/.github/workflows/luarocks.yml +++ b/.github/workflows/luarocks.yml @@ -29,4 +29,3 @@ jobs: version: ${{ env.LUAROCKS_VERSION }} dependencies: | nvim-web-devicons - gitsigns.nvim diff --git a/.gitignore b/.gitignore index 926ccaa..5f13a93 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,5 @@ doc/tags +/luarocks +/lua +/lua_modules +/.luarocks diff --git a/README.md b/README.md index 4295bf8..e3e3782 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,6 @@ Neovim, Feline and matching Tmux Theme Configuration can be found in the following [repo] within [feline.lua]. - ## About Feline is a Lua statusline, statuscolumn and winbar plugin that prioritizes @@ -74,6 +73,12 @@ repository is the plugins new home as per ## Installation +This plugin is available on [LuaRocks]: + +```text +:Rocks install feline.nvim +``` + [lazy.nvim] ```lua @@ -290,15 +295,16 @@ guess the name fits. [a patched font]: https://github.com/ryanoasis/nerd-fonts [built-in providers]: USAGE.md#default-providers [contributing]: CONTRIBUTING.md +[feline.lua]: https://github.com/freddiehaddad/nvim/blob/main/lua/plugins/feline.lua [gitsigns.nvim]: https://github.com/lewis6991/gitsigns.nvim/ [issue]: https://github.com/freddiehaddad/feline.nvim/issues [issue or pull request]: CONTRIBUTING.md [lazy.nvim]: https://github.com/folke/lazy.nvim [license.md]: LICENSE.md +[luarocks]: https://luarocks.org/modules/freddiehaddad/feline.nvim [neovim's built-in lsp]: https://neovim.io/doc/user/lsp.html [nvim-web-devicons]: https://github.com/kyazdani42/nvim-web-devicons/ [packer.nvim]: https://github.com/wbthomason/packer.nvim/ +[repo]: https://github.com/freddiehaddad/nvim [usage]: USAGE.md [vim-plug]: https://github.com/junegunn/vim-plug/ -[repo]: https://github.com/freddiehaddad/nvim -[feline.lua]: https://github.com/freddiehaddad/nvim/blob/main/lua/plugins/feline.lua diff --git a/feline.nvim-dev-1.rockspec b/feline.nvim-dev-1.rockspec new file mode 100644 index 0000000..c97a862 --- /dev/null +++ b/feline.nvim-dev-1.rockspec @@ -0,0 +1,37 @@ +package = "feline.nvim" +version = "dev-1" +source = { + url = "git+ssh://git@github.com/freddiehaddad/feline.nvim.git" +} +description = { + detailed = [[ +![GitHub last commit (branch)](https://img.shields.io/github/last-commit/freddiehaddad/feline.nvim/main?style=for-the-badge) +![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/freddiehaddad/feline.nvim?style=for-the-badge) +![GitHub issues](https://img.shields.io/github/issues/freddiehaddad/feline.nvim?style=for-the-badge) +![GitHub Discussions](https://img.shields.io/github/discussions/freddiehaddad/feline.nvim?style=for-the-badge) +![GitHub Repo stars](https://img.shields.io/github/stars/freddiehaddad/feline.nvim?style=for-the-badge)]], + homepage = "*** please enter a project homepage ***", + license = "*** please specify a license ***" +} +build = { + type = "builtin", + modules = { + ["feline.default_components"] = "lua/feline/default_components.lua", + ["feline.defaults"] = "lua/feline/defaults.lua", + ["feline.generator"] = "lua/feline/generator.lua", + ["feline.init"] = "lua/feline/init.lua", + ["feline.providers.cursor"] = "lua/feline/providers/cursor.lua", + ["feline.providers.file"] = "lua/feline/providers/file.lua", + ["feline.providers.git"] = "lua/feline/providers/git.lua", + ["feline.providers.init"] = "lua/feline/providers/init.lua", + ["feline.providers.lsp"] = "lua/feline/providers/lsp.lua", + ["feline.providers.statuscolumn"] = "lua/feline/providers/statuscolumn.lua", + ["feline.providers.vi_mode"] = "lua/feline/providers/vi_mode.lua", + ["feline.themes.default"] = "lua/feline/themes/default.lua", + ["feline.themes.init"] = "lua/feline/themes/init.lua", + ["feline.utils"] = "lua/feline/utils.lua" + }, + copy_directories = { + "doc" + } +}