From 2f2bb2055056602b1e5159346ea2dbf75a3522e4 Mon Sep 17 00:00:00 2001 From: veeso Date: Fri, 21 May 2021 12:59:42 +0200 Subject: [PATCH] readme --- CHANGELOG.md | 2 +- README.md | 40 +++++++++++++++++++--------------------- 2 files changed, 20 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f404da7..86ea005 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -53,7 +53,7 @@ Released on FIXME: ?? - Removed the goold old figlet title - Protocol input as first field in UI - Port is now updated to standard for selected protocol - - when you change the protocol in the authentication form and the current port is standard (`< 1024`), the port will be automatically changed to default value for the selected protocol (e.g. current port: `123`, protocol is changes to `FTP`, port becomes `21`) + - when you change the protocol in the authentication form and the current port is standard (`< 1024`), the port will be automatically changed to default value for the selected protocol (e.g. current port: `123`, protocol changed to `FTP`, port becomes `21`) - Bugfix: - Fixed wrong text wrap in log box - Fixed empty bookmark name causing termscp to crash diff --git a/README.md b/README.md index 5dc08d8..51d2ab2 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,8 @@ Current version: 0.5.0 FIXME: (13/04/2021) - [termscp](#termscp) - [About termscp ๐Ÿ–ฅ](#about-termscp-) - - [Why termscp ๐Ÿค”](#why-termscp-) - [Features ๐ŸŽ](#features-) - - [Installation ๐Ÿ› ](#installation-) + - [Get started ๐Ÿ](#get-started-) - [Cargo ๐Ÿฆ€](#cargo-) - [Deb package ๐Ÿ“ฆ](#deb-package-) - [RPM package ๐Ÿ“ฆ](#rpm-package-) @@ -46,39 +45,37 @@ Termscp is a feature rich terminal file transfer and explorer, with support for --- -### Why termscp ๐Ÿค” - -It happens quite often to me, when using SCP at work to forget the path of a file on a remote machine, which forces me to connect through SSH, gather the file path and finally download it through SCP. I could use WinSCP, but I use Linux and I pratically use the terminal for everything, so I wanted something like WinSCP on my terminal. Yeah, I know there is midnight commander too, but actually I don't like it very much tbh (and hasn't a decent support for scp). - ## Features ๐ŸŽ -- ๐Ÿ“ Different communication protocols support +- ๐Ÿ“ Different communication protocols support - SFTP - SCP - FTP and FTPS -- ๐Ÿง Compatible with Windows, Linux, BSD and MacOS -- ๐Ÿ–ฅ Handy user interface to explore and operate on the remote and on the local machine file system +- ๐Ÿ–ฅ Explore and operate on the remote and on the local machine file system with a handy UI - Create, remove, rename, search, view and edit files -- โญ Bookmarks and recent connections can be saved to access quickly to your favourite hosts -- ๐Ÿ“ Supports text editors to view and edit text files -- ๐Ÿ’ Supports both SFTP/SCP authentication through SSH keys and username/password -- โœ Customizations +- โญ Connect to your favourite hosts through built-in bookmarks and recent connections +- ๐Ÿ“ View and edit text files with your favourite text editor +- ๐Ÿ’ SFTP/SCP authentication through SSH keys and username/password +- ๐Ÿง Compatible with Windows, Linux, BSD and MacOS +- โœ Customizable - Custom file explorer format - Customizable text editor - Customizable file sorting -- ๐Ÿ” SSH key storage -- ๐Ÿฆ€ Written in Rust -- ๐Ÿค Easy to extend with new file transfers protocols -- ๐Ÿ‘€ Developed keeping an eye on performance -- ๐Ÿฆ„ Frequent awesome updates +- ๐Ÿ” Save your password in your operating system key vault +- ๐Ÿฆ€ Rust-powered +- ๐Ÿค Easy to extend with new file transfers protocols +- ๐Ÿ‘€ Developed keeping an eye on performance +- ๐Ÿฆ„ Frequent awesome updates --- -## Installation ๐Ÿ›  +## Get started ๐Ÿ If you're considering to install termscp I want to thank you ๐Ÿ’œ ! I hope you will enjoy termscp! If you want to contribute to this project, don't forget to check out our contribute guide. [Read More](CONTRIBUTING.md) +You can opt for any of these methods, according to your systems and preferences: + ### Cargo ๐Ÿฆ€ ```sh @@ -127,7 +124,7 @@ yay -S termscp ### Chocolatey ๐Ÿซ -You can install termscp on Windows using [chocolatey](https://chocolatey.org/) +You can install termscp on Windows via [chocolatey](https://community.chocolatey.org/packages/termscp) Start PowerShell as administrator and run @@ -176,7 +173,7 @@ The developer documentation can be found on Rust Docs at