From 30e370709a73286bd8a7a34fa4683f300b5cf4ab Mon Sep 17 00:00:00 2001 From: Chen Asraf Date: Sun, 4 Feb 2024 00:26:53 +0200 Subject: [PATCH] docs: update readme + add funding --- .github/FUNDING.yml | 12 ++++++++ README.md | 69 ++++++++++++++++++++++----------------------- 2 files changed, 46 insertions(+), 35 deletions(-) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..8d71af7b --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,12 @@ +# These are supported funding model platforms + +github: chenasraf +patreon: # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: casraf +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +otechie: # Replace with a single Otechie username +custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/README.md b/README.md index e33e242e..024655b4 100644 --- a/README.md +++ b/README.md @@ -27,41 +27,40 @@ Plugins are installed and configured in `.config/nvim` and its subdirectory `lua Some (but not all) of the plugins/modifications are listed here: -| File | Description | Related plugins | -| -------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `autoformat.lua` | Code auto formatting | [neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) | -| `barbar.lua` | Tabs | [omgrk/barbar.nvim](https://github.com/omgrk/barbar.nvim) | -| `colorscheme.lua` | Color scheme switcher | | -| `copilot.lua` | Copilot (CMP) | [zbirenbaum/copilot.lua](https://github.com/zbirenbaum/copilot.lua) | -| `dadbod.lua` | Dadbod - Database manager for nvim | [tpope/vim-dadbod](https://github.com/tpope/vim-dadbod) | -| `debug.lua` | Debugger-related code, most of these are not maintained/tested | [mfussenegger/nvim-dap](https://github.com/mfussenegger/nvim-dap) | -| `floating-input.lua` | Floating input | [liangxianzhe/floating-input.nvim](https://github.com/liangxianzhe/floating-input.nvim) | -| `fugitive.lua` | Git manager - I use LazyGit now, but this remain mostly for git blame functionality | [tpope/vim-fugitive](https://github.com/tpope/vim-fugitive) | -| `lazygit.lua` | LazyGit inside nvim | [kdheepak/lazygit.nvim](https://github.com/kdheepak/lazygit.nvim) | -| `llm.lua` | LLM - ChatGPT/Codeium | [Exafunction/codeium.nvim](https://github.com/Exafunction/codeium.nvim), [jackMort/ChatGPT.nvim](https://github.com/jackMort/ChatGPT.nvim) | -| `lsp.lua` | LSP related configs | [williamboman/mason-lspconfig.nvim](https://github.com/williamboman/mason-lspconfig.nvim), [akinsho/flutter-tools.nvim](https://github.com/akinsho/flutter-tools.nvim) | -| `matchup.lua` | Enables moving between function start/end as you would between brackets using `%` | [andymass/vim-matchup](https://github.com/andymass/vim-matchup) | -| `media_files.lua` | Telescope plugin to show media file previews | [nvim-telescope/telescope-media-files.nvim](https://github.com/nvim-telescope/telescope-media-files.nvim) | -| `noice.lua` | Notifications & UI improvements | [folke/noice.nvim](https://github.com/folke/noice.nvim) | -| `nvim-test.lua` | Run tests for any project type inside nvim | [klen/nvim-test](https://github.com/klen/nvim-test) | -| `oil.lua` | Better than netrw. Fight me. (Lets you move between and edit directories as you would a normal file) | [stevearc/oil.nvim](https://github.com/stevearc/oil.nvim) | -| `prettier.lua` | Implements prettier code formatter into lua | [MunifTanjim/prettier.nvim](https://github.com/MunifTanjim/prettier.nvim) | -| `project_runner.lua` | Run prepared terminal commands per filetype - e.g. package.json scripts from ts/js files (Not a plugin) | | -| `quicklist.lua` | Delete/add to vim quicklist | | -| `quotes.lua` | Allows you to toggle between `\``, `"`and`'` quotes around the cursor | | -| `remap.lua` | General vim remaps not related to specific plugins | | -| `schemastore.lua` | Auto-loads JSON `$schema` depending on filetype and name | [b0o/schemastore.nvim](https://github.com/b0o/schemastore.nvim) | -| `sort.lua` | Sort selected lines | [sQVe/sort.nvim](https://github.com/sQVe/sort.nvim) | -| `statusline.lua` | Status line UI updates | [nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) | -| `surround.lua` | Surround any text with anything like brackets, quotes, HTML tags or custom strings | [kylechui/nvim-surround](https://github.com/kylechui/nvim-surround) | -| `telescope.lua` | Fuzzy finder, preview and picker for files/commands/custom | [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) | -| `text-transform.lua` | Transform between PascalCase, snake_case, camelCase, CONST_CASE and more | [chenasraf/text-transform.nvim](https://github.com/chenasraf/text-transform.nvim) | -| `theme.lua` | Theme configuration (OneDark) | [navarasu/onedark.nvim](https://github.com/navarasu/onedark.nvim) | -| `todo_comments.lua` | Highlight & find TODO/HACK/FIXME/etc in comments across the project | [folke/todo-comments.nvim](https://github.com/folke/todo-comments.nvim) | -| `treesitter.lua` | Syntax highlighting on steroids | [nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) | -| `trouble.lua` | View list of diagnostics, quick fixes, TODOs, etc | [folke/trouble.nvim](https://github.com/folke/trouble.nvim) | -| `undotree.lua` | Undo each file as you would a git branch! | [mbbill/undotree](https://github.com/mbbill/undotree) | -| `visual-multi.lua` | Multiple cursor support for nvim | [mg979/vim-visual-multi](https://github.com/mg979/vim-visual-multi) | +| File | Description | Related plugins | +| -------------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `autoformat.lua` | Code auto formatting | [neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) | +| `barbar.lua` | Tabs | [omgrk/barbar.nvim](https://github.com/omgrk/barbar.nvim) | +| `colorscheme.lua` | Color scheme switcher | | +| `dadbod.lua` | Dadbod - Database manager for nvim | [tpope/vim-dadbod](https://github.com/tpope/vim-dadbod) | +| `debug.lua` | Debugger-related code, most of these are not maintained/tested | [mfussenegger/nvim-dap](https://github.com/mfussenegger/nvim-dap) | +| `floating-input.lua` | Floating input | [liangxianzhe/floating-input.nvim](https://github.com/liangxianzhe/floating-input.nvim) | +| `fugitive.lua` | Git manager - I use LazyGit now, but this remain mostly for git blame functionality | [tpope/vim-fugitive](https://github.com/tpope/vim-fugitive) | +| `lazygit.lua` | LazyGit inside nvim | [kdheepak/lazygit.nvim](https://github.com/kdheepak/lazygit.nvim) | +| `llm.lua` | LLM - Copilot, ChatGPT (requires `OPENAI_API_KEY` env), Codeium | [zbirenbaum/copilot.lua](https://github.com/zbirenbaum/copilot.lua), [Exafunction/codeium.nvim](https://github.com/Exafunction/codeium.nvim), [jackMort/ChatGPT.nvim](https://github.com/jackMort/ChatGPT.nvim) | +| `lsp.lua` | LSP related configs | [williamboman/mason-lspconfig.nvim](https://github.com/williamboman/mason-lspconfig.nvim), [akinsho/flutter-tools.nvim](https://github.com/akinsho/flutter-tools.nvim) | +| `matchup.lua` | Enables moving between function start/end as you would between brackets using `%` | [andymass/vim-matchup](https://github.com/andymass/vim-matchup) | +| `media_files.lua` | Telescope plugin to show media file previews | [nvim-telescope/telescope-media-files.nvim](https://github.com/nvim-telescope/telescope-media-files.nvim) | +| `noice.lua` | Notifications & UI improvements | [folke/noice.nvim](https://github.com/folke/noice.nvim) | +| `nvim-test.lua` | Run tests for any project type inside nvim | [klen/nvim-test](https://github.com/klen/nvim-test) | +| `oil.lua` | Better than netrw. Fight me. (Lets you move between and edit directories as you would a normal file) | [stevearc/oil.nvim](https://github.com/stevearc/oil.nvim) | +| `prettier.lua` | Implements prettier code formatter into lua | [MunifTanjim/prettier.nvim](https://github.com/MunifTanjim/prettier.nvim) | +| `project_runner.lua` | Run prepared terminal commands per filetype - e.g. package.json scripts from ts/js files (Not a plugin) | | +| `quicklist.lua` | Delete/add to vim quicklist | | +| `quotes.lua` | Allows you to toggle between `\``, `"`and`'` quotes around the cursor | | +| `remap.lua` | General vim remaps not related to specific plugins | | +| `schemastore.lua` | Auto-loads JSON `$schema` depending on filetype and name | [b0o/schemastore.nvim](https://github.com/b0o/schemastore.nvim) | +| `sort.lua` | Sort selected lines | [sQVe/sort.nvim](https://github.com/sQVe/sort.nvim) | +| `statusline.lua` | Status line UI updates | [nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) | +| `surround.lua` | Surround any text with anything like brackets, quotes, HTML tags or custom strings | [kylechui/nvim-surround](https://github.com/kylechui/nvim-surround) | +| `telescope.lua` | Fuzzy finder, preview and picker for files/commands/custom | [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) | +| `text-transform.lua` | Transform between PascalCase, snake_case, camelCase, CONST_CASE and more | [chenasraf/text-transform.nvim](https://github.com/chenasraf/text-transform.nvim) | +| `theme.lua` | Theme configuration (OneDark) | [navarasu/onedark.nvim](https://github.com/navarasu/onedark.nvim) | +| `todo_comments.lua` | Highlight & find TODO/HACK/FIXME/etc in comments across the project | [folke/todo-comments.nvim](https://github.com/folke/todo-comments.nvim) | +| `treesitter.lua` | Syntax highlighting on steroids | [nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) | +| `trouble.lua` | View list of diagnostics, quick fixes, TODOs, etc | [folke/trouble.nvim](https://github.com/folke/trouble.nvim) | +| `undotree.lua` | Undo each file as you would a git branch! | [mbbill/undotree](https://github.com/mbbill/undotree) | +| `visual-multi.lua` | Multiple cursor support for nvim | [mg979/vim-visual-multi](https://github.com/mg979/vim-visual-multi) | ## How to install