From 75b0170461de37021c3e44a97a57eaf4993e235a Mon Sep 17 00:00:00 2001
From: Adem Baccara <71262172+Adembc@users.noreply.github.com>
Date: Sat, 30 Aug 2025 15:53:31 +0100
Subject: [PATCH] improve docs (#4)
---
README.md | 87 ++++++++++++++++++++++++++++++-------------
docs/add server.png | Bin 0 -> 51032 bytes
docs/list server.png | Bin 0 -> 356051 bytes
docs/loader.png | Bin 0 -> 49602 bytes
docs/search.png | Bin 0 -> 164797 bytes
docs/ssh.png | Bin 0 -> 24090 bytes
makefile | 2 +-
7 files changed, 62 insertions(+), 27 deletions(-)
create mode 100644 docs/add server.png
create mode 100644 docs/list server.png
create mode 100644 docs/loader.png
create mode 100644 docs/search.png
create mode 100644 docs/ssh.png
diff --git a/README.md b/README.md
index 8f45bc1..0027f9d 100644
--- a/README.md
+++ b/README.md
@@ -7,13 +7,12 @@
Lazyssh is a terminal-based, interactive SSH manager inspired by tools like lazydocker and k9s β but built for managing your fleet of servers directly from your terminal.
With lazyssh, you can quickly navigate, connect, manage, and transfer files between your local machine and any server defined in your ~/.ssh/config. No more remembering IP addresses or running long scp commands β just a clean, keyboard-driven UI.
-## π₯ Demo
-
+---
## β¨ Features
-### Server Management (current)
+### Server Management
- π Read & display servers from your `~/.ssh/config` in a scrollable list.
- β Add a new server from the UI by specifying alias, host/IP, username, port, identity file.
- β Edit existing server entries directly from the UI.
@@ -32,10 +31,51 @@ With lazyssh, you can quickly navigate, connect, manage, and transfer files betw
- π Copy files between local and servers with an easy picker UI.
- π‘ Port forwarding (localβremote) from the UI.
- π Enhanced Key Management:
- - Use default local public key (~/.ssh/id_ed25519.pub or ~/.ssh/id_rsa.pub)
- - Paste custom public keys manually
- - Generate new keypairs and deploy them
- - Automatically append keys to ~/.ssh/authorized_keys with correct permissions
+ - Use default local public key (~/.ssh/id_ed25519.pub or ~/.ssh/id_rsa.pub)
+ - Paste custom public keys manually
+ - Generate new keypairs and deploy them
+ - Automatically append keys to ~/.ssh/authorized_keys with correct permissions
+---
+
+## π· Screenshots
+
+
+
+Clean loading screen when launching the app
+
+---
+
+### π Server Management Dashboard
+
+
+Main dashboard displaying all configured servers with status indicators, pinned favorites at the top, and easy navigation
+
+---
+
+### π Search
+
+
+Fuzzy search functionality to quickly find servers by name, IP address, or tags
+
+---
+
+### β Add Server
+
+
+User-friendly form interface for adding new SSH connections.
+
+---
+
+### π Connect to server
+
+
+SSH into the selected server
+
+