diff --git a/README.md b/README.md index 84a2bb1..cd3e411 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,26 @@ # Neovim Configuration -A clean, modular Neovim setup focused on TypeScript/JavaScript development. +Modular Neovim setup for TypeScript/JavaScript development. -## Structure +## Installation -``` -~/.config/nvim/ -├── init.lua # Entry point -└── lua/ - ├── core/ - │ ├── options.lua # Vim settings - │ └── keymaps.lua # Key bindings - └── plugins/ - └── plugin.lua # Plugin specs & configs +```bash +# Clone to config directory +git clone ~/.config/nvim + +# Symlink dotfiles (optional) +./setup.sh + +# Launch Neovim - plugins install automatically +nvim ``` ## Features -- **Package Manager**: lazy.nvim -- **Color Scheme**: Catppuccin Mocha -- **File Explorer**: nvim-tree -- **Fuzzy Finder**: Telescope -- **LSP**: Mason + nvim-lspconfig -- **Autocompletion**: nvim-cmp with LSP support -- **Syntax**: Treesitter -- **Formatter**: Conform (Prettier) -- **Snippets**: LuaSnip + friendly-snippets - -## Key Bindings +- LSP with TypeScript/JavaScript support +- Autocompletion and snippets +- Telescope fuzzy finder +- Treesitter syntax highlighting +- Format-on-save with Prettier Leader key: `` - -| Key | Action | -|-----|--------| -| `e` | Toggle file explorer | -| `ff` | Find files | -| `fg` | Live grep | -| `fb` | Find buffers | -| `w` | Save | -| `q` | Quit | -| `` | Navigate windows | - -## Installation - -1. Clone this repo to `~/.config/nvim` -2. Open Neovim - plugins will install automatically -3. Restart Neovim - -## LSP Servers - -Mason will auto-install: -- ts_ls (TypeScript) -- eslint -- jsonls -- html -- cssls -- tailwindcss