From 90eec9d4a83c8718612f6c7b1bebb99e23c1362e Mon Sep 17 00:00:00 2001 From: Luke Hamburg <1992842+luckman212@users.noreply.github.com> Date: Sat, 24 Jan 2026 11:16:41 -0500 Subject: [PATCH] Update README.md add note about quitting app --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 42e0745..6807502 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ ![crates.io](https://img.shields.io/crates/v/filessh) ![GitHub Tag](https://img.shields.io/github/v/tag/jayanaxhf/filessh) - A TUI-based file explorer for SSH servers, which allows you to browse and manage files on a remote server, edit them in-place, and recursively download directories with parallel directory traversal. It also has the ability to quickly spawn SSH sessions to paths on the remote server. Dual-licensed under MIT or the [UNLICENSE](https://unlicense.org/). @@ -12,10 +11,13 @@ Dual-licensed under MIT or the [UNLICENSE](https://unlicense.org/). ![Made with VHS](https://vhs.charm.sh/vhs-3OLXZvjKpqe5qR7hxsftQF.gif) ## Installation + ### Cargo + ```sh cargo install --locked filessh ``` + ### Build from source 1. Ensure you have Rust and Cargo installed. You can find installation instructions at [rust-lang.org](https://www.rust-lang.org/tools/install). @@ -35,17 +37,13 @@ cargo install --locked filessh - [ ] Add support for rsync and scp - [ ] Iron out bugs -## Usage +## Features -```sh -filessh [OPTIONS] -``` -### Features 1. Modify, delete and browse files on a remote server 2. Recursively download directories with parallel directory traversal 3. Quickly open SSH sessions to directories. -### Usage +## Usage ``` filessh [OPTIONS] [HOST] [PATH] @@ -73,6 +71,9 @@ Options: Print help -V, --version Print version + +To exit the app, press ⌃q (ctrl+q) + ``` ### Example