Skip to content

Commit 24bffc1

Browse files
committed
docs: revise README for clarity and conciseness
Restructure the 'Features' section with more descriptive and action-oriented bullet points. Improve overall language for better readability and conciseness.
1 parent 4ce00db commit 24bffc1

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,30 +14,28 @@
1414
</p>
1515

1616
<p align="center">
17-
A minimal, fast <strong>SSHFS</strong> integration for <strong>NeoVim</strong> that <strong>works with YOUR setup</strong>.
17+
A fast <strong>SSHFS/SSH</strong> integration for <strong>NeoVim</strong> that <strong>works with your setup</strong>.
1818
</p>
1919

20-
## 🕶️ What does it do?
20+
## 🕶️ What It Is & Why
2121

22-
Mount remote hosts from your SSH config and work with remote files/hosts as if they were local.
22+
sshfs.nvim mounts hosts from your SSH config and makes them feel local. You can bbrowse, search, change directories, run commands, or open SSH terminals across multiple mounts without changing your workflow.
2323

24-
Browse, search, change directories, run commands, or open ssh terminal connections from NeoVim with zero forced dependencies.
25-
26-
Auto-detects your tools: **snacks**, **telescope**, **fzf-lua**, **mini**, **oil**, **yazi**, **nnn**, **ranger**, **lf**, **neo-tree**, **nvim-tree**, or **netrw**.
24+
It stays lightweight and modern: no forced dependencies, built for Neovim 0.10+ with `sshfs` and `ssh` toolkits using your existing tools.
2725

2826
<https://github.com/user-attachments/assets/20419da8-37b9-4325-a942-90a85754ce11>
2927

3028
## ✨ Features
3129

32-
- **Zero dependencies** - Works with your existing file pickers and search tools, no forced plugins
33-
- **Auto-detection** - Launches telescope, oil, snacks, fzf-lua, mini, yazi, neo-tree, nvim-tree, ranger, lf, nnn, or netrw
34-
- **On-mount hooks** - Run your own function or built-ins (find, grep, live find/grep) right after a mount
35-
- **Live remote search** - Stream `rg`/`find` over SSH with snacks, fzf-lua, telescope, or mini (no local mount thrashing)
36-
- **Flexible workflow** - Explore files, change directories (`tcd`), run custom commands, or open SSH terminals
37-
- **Universal auth** - Handles SSH keys, 2FA, passwords, passphrases, host verification via floating terminal
38-
- **ControlMaster** - Enter credentials once, reuse for all operations (mount, terminal, git, scp)
39-
- **Full SSH config** - Supports Include, Match, ProxyJump, and all `ssh_config` features via `ssh -G`
40-
- **Modern Neovim** - Built for 0.10+ with vim.uv, modular architecture, cross-platform
30+
- **Uses your toolkit** – Auto-detects **snacks**, **telescope**, **fzf-lua**, **mini**, **oil**, **yazi**, **nnn**, **ranger**, **lf**, **neo-tree**, **nvim-tree**, or **netrw**.
31+
- **Auth that sticks** – ControlMaster sockets + floating auth handle keys/passwords/2FA once, then reuse for mounts, live search, terminals, git, or scp.
32+
- **Real SSH config support** – Honors Include/Match/ProxyJump and all `ssh_config` options via `ssh -G`; optional per-host default paths.
33+
- **On-mount hooks** – Auto-run find/grep/live find/live grep/terminal or your own function after connecting.
34+
- **Live remote search** – Stream `rg`/`find` over SSH (snacks, fzf-lua, telescope, mini) while keeping mounts quiet.
35+
- **Multi-mount aware** – Connect to several hosts, clean up on exit, and jump between mounts with keymaps or commands.
36+
- **Command suite** `:SSHFiles`, `:SSHGrep`, `:SSHLiveFind/Grep`, `:SSHTerminal`, `:SSHCommand`, `:SSHChangeDir`, `:SSHConfig`, `:SSHReload`.
37+
- **Host-aware defaults** – Optional per-host default paths so you can skip path prompts on common servers.
38+
- **Modern Neovim** Built for 0.10+ with `vim.uv` for reliable jobs, sockets, and cleanup.
4139

4240
## 📋 Requirements
4341

0 commit comments

Comments
 (0)