Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jkeresman01 committed Sep 28, 2024
1 parent 392027b commit e5925f5
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
- [Commands](#commands)
- [Setup](#setup)



## The problem :warning: <a name="problem"></a> ##
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.

Expand All @@ -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: <a name="repo"></a> ##

```bash
Expand All @@ -45,18 +49,23 @@ tmux-switch.nvim/
└── README.md
```


## Functionalities :pick: <a name="functionalities"></a> ##

- [x] Fuzzy find trough all tmux session and navigate to selected one
- [x] Floating UI for creating new sessions
- [x] Floating UI for renaming current session
- [ ] Quick switch between 2 most used sessions



## Installation :star: <a name="installation"></a> ##
* Make sure you have Neovim v0.9.0 or greater. :exclamation:
* Dependecies: nui && telescope && plenary (telescope dep)
* Install using you plugin manager



#### Vim Plug <a name="vimplug"></a> ####
```lua
Plug 'nvim-lua/plenary.nvim'
Expand All @@ -66,6 +75,8 @@ Plug 'MunifTanjim/nui.nvim'
Plug 'jkeresman01/tmux-switch.nvim'
```



#### Packer <a name="packer"></a> ####
```lua

Expand All @@ -80,6 +91,8 @@ use 'MunifTanjim/nui.nvim'
use 'jkeresman01/tmux-switch.nvim'
```



## Commands :wrench: <a name="commands"></a> ##

Following commands have been exposed to Neovim:
Expand All @@ -93,6 +106,8 @@ Following commands have been exposed to Neovim:

```



## Setup :wrench: <a name="setup"></a> ##

Set the keymapings as you see fit, here is one example:
Expand All @@ -106,6 +121,7 @@ vim.keymap.set("n", "<leader>rs", "<CMD>TmuxRenameSession<CR>"

```


| Key - map | Action |
|---------------|--------------------------------------------------------------------|
| `<C-f>` | Lunch TMUX switch UI (fuzzy search trough tmux sessions) |
Expand Down

0 comments on commit e5925f5

Please sign in to comment.