From e5925f5fb21db608e7289248ad0134e7da01d053 Mon Sep 17 00:00:00 2001 From: josip Date: Sat, 28 Sep 2024 15:22:35 +0200 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index d75c8e3..8f765d5 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,8 @@ - [Commands](#commands) - [Setup](#setup) + + ## The problem :warning: ## When you are in Neovim, switching between multiple TMUX sessions can be cumbersome, requiring you to leave your editor and manually navigate the command line. This disrupts your workflow, especially when managing numerous sessions. The constant context-switching between the terminal and Neovim slows down productivity and can be frustrating for users who need a more seamless experience. @@ -30,6 +32,8 @@ TMUX Switch solves this problem by integrating fuzzy search within Neovim, allow [![asciicast](https://asciinema.org/a/27TU99A43TXp2578nZfWcKiZ6.svg)](https://asciinema.org/a/27TU99A43TXp2578nZfWcKiZ6) + + ## Repository structure :open_file_folder: ## ```bash @@ -45,6 +49,7 @@ tmux-switch.nvim/ └── README.md ``` + ## Functionalities :pick: ## - [x] Fuzzy find trough all tmux session and navigate to selected one @@ -52,11 +57,15 @@ tmux-switch.nvim/ - [x] Floating UI for renaming current session - [ ] Quick switch between 2 most used sessions + + ## Installation :star: ## * Make sure you have Neovim v0.9.0 or greater. :exclamation: * Dependecies: nui && telescope && plenary (telescope dep) * Install using you plugin manager + + #### Vim Plug #### ```lua Plug 'nvim-lua/plenary.nvim' @@ -66,6 +75,8 @@ Plug 'MunifTanjim/nui.nvim' Plug 'jkeresman01/tmux-switch.nvim' ``` + + #### Packer #### ```lua @@ -80,6 +91,8 @@ use 'MunifTanjim/nui.nvim' use 'jkeresman01/tmux-switch.nvim' ``` + + ## Commands :wrench: ## Following commands have been exposed to Neovim: @@ -93,6 +106,8 @@ Following commands have been exposed to Neovim: ``` + + ## Setup :wrench: ## Set the keymapings as you see fit, here is one example: @@ -106,6 +121,7 @@ vim.keymap.set("n", "rs", "TmuxRenameSession" ``` + | Key - map | Action | |---------------|--------------------------------------------------------------------| | `` | Lunch TMUX switch UI (fuzzy search trough tmux sessions) |