Updated readme

README.md

@@ -1 +1,118 @@
-My neovim config
+# Jachym's Neovim Config
+
+This setup is designed to enhance your coding experience with a variety of plugins for improved aesthetics, functionality, and productivity.
+
+## Installation
+
+- Clone this repo to your nvim config
+
+```sh
+git clone https://git.pupes.org/jachym/nvim ~/.config/nvim
+```
+
+- Start Neovim
+
+```sh
+nvim
+```
+
+## Usage
+
+### General
+
+| key         | description        |
+| ----------- | ------------------ |
+| `<esc>`     | clear hlsearch     |
+| `<c-h>`     | go to left window  |
+| `<c-j>`     | go to lower window |
+| `<c-k>`     | go to upper window |
+| `<c-l>`     | go to right window |
+| `<Leader>l` | open lazy          |
+
+### FZF
+
+| key          | description |
+| ------------ | ----------- |
+| `<Leader>ff` | files       |
+| `<Leader>fb` | buffers     |
+| `<Leader>fh` | oldfiles    |
+| `<Leader>fg` | live grep   |
+
+### Tree
+
+| key         | description |
+| ----------- | ----------- |
+| `<Leader>e` | toggle tree |
+
+### LSP
+
+| key          | description      |
+| ------------ | ---------------- |
+| `<Leader>cm` | open mason       |
+| `gd`         | go to definition |
+| `<Leader>cr` | rename           |
+| `<Leader>ca` | code actions     |
+
+### Treesitter
+
+| key         | description         |
+| ----------- | ------------------- |
+| `<c-space>` | increment selection |
+| `<bs>`      | decrement selection |
+
+## Plugins Overview
+
+Below is a breakdown of the key components of my configuration.
+
+### Colorscheme
+- **`bluz71/vim-moonfly-colors`**  
+  A dark charcoal theme
+
+### LSP
+- **`neovim/nvim-lspconfig`**  
+  Provides configurations and an abstraction layer for setting up LSP
+  
+- **`williamboman/mason.nvim`**  
+  A package manager for LSP servers
+
+- **`williamboman/mason-lspconfig.nvim`**  
+  Integrates Mason with nvim-lspconfig, making it easier to use LSP configurations with Mason
+
+### Autocompletion
+- **`saghen/blink.cmp`**  
+  A fast auto-completion plugin
+
+- **`rafamadriz/friendly-snippets`**  
+  A collection of useful snippets
+
+### Formatting
+- **`stevearc/conform.nvim`**  
+  A lightweight yet powerful formatter plugin
+
+### User Interface (UI)
+- **`nvim-lualine/lualine.nvim`**  
+  A customizable status line that provides useful information
+
+- **`akinsho/bufferline.nvim`**  
+  Displays opened buffers in a visually appealing way
+
+### Misc
+- **`nvim-tree/nvim-tree.lua`**  
+  A file explorer that allows for easy file management
+
+- **`nvim-tree/nvim-web-devicons`**  
+  Adds icon support for various plugins
+
+- **`ibhagwan/fzf-lua`**  
+  A powerful fuzzy finder for everything
+
+- **`windwp/nvim-autopairs`**  
+  Automatically inserts closing pairs for brackets, quotes, and more
+
+- **`nvim-treesitter/nvim-treesitter`**  
+  Provides advanced syntax highlighting and code parsing capabilities
+
+
+## Contributing
+
+Feel free to contribute to this configuration by submitting issues or pull requests. Your feedback and suggestions are welcome!

lua/plugins/bufferline.lua

@@ -1,7 +1,7 @@
 return {
-	'akinsho/bufferline.nvim',
+	"akinsho/bufferline.nvim",
 	version = "*",
-	dependencies = { 'nvim-tree/nvim-web-devicons' },
+	dependencies = { "nvim-tree/nvim-web-devicons" },
 	lazy = false,
 	opts = {},
 }

lua/plugins/fzf.lua

@@ -16,5 +16,5 @@ return {
 		vim.keymap.set("n", "<leader>fb", fzf_lua.buffers)
 		vim.keymap.set("n", "<leader>fh", fzf_lua.oldfiles)
 		vim.keymap.set("n", "<leader>fg", fzf_lua.live_grep)
-	end
+	end,
 }

lua/plugins/lualine.lua

@@ -1,9 +1,9 @@
 return {
-	'nvim-lualine/lualine.nvim',
-	dependencies = { 'nvim-tree/nvim-web-devicons' },
+	"nvim-lualine/lualine.nvim",
+	dependencies = { "nvim-tree/nvim-web-devicons" },
 	lazy = false,
 	opts = {
-		options = { section_separators = '', component_separators = '' },
-		extensions = { "fzf", "lazy", "man", "mason", "nvim-tree"},
+		options = { section_separators = "", component_separators = "" },
+		extensions = { "fzf", "lazy", "man", "mason", "nvim-tree" },
 	},
 }

lua/plugins/moonfly.lua

@@ -8,5 +8,5 @@ return {
 	end,
 	config = function()
 		vim.cmd("colorscheme moonfly")
-	end
+	end,
 }

lua/plugins/nvim-tree.lua

@@ -9,6 +9,6 @@ return {
 
 		local api = require("nvim-tree.api")
 
-		vim.keymap.set("n", "<leader>e", api.tree.toggle )
+		vim.keymap.set("n", "<leader>e", api.tree.toggle)
 	end,
 }