Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lonnywong committed Jan 14, 2024
1 parent f3a65aa commit f0e7ecc
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
10 changes: 6 additions & 4 deletions README.cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

支持 [trzsz](https://trzsz.github.io/cn/) ( trz / tsz ) 的 ssh 客户端,支持搜索和选择服务器进行批量登录,支持记住密码。

Website: [https://trzsz.github.io/ssh](https://trzsz.github.io/ssh) ( English )  中文文档:[https://trzsz.github.io/cn/ssh](https://trzsz.github.io/cn/ssh)

[![MIT License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://choosealicense.com/licenses/mit/)
[![GitHub Release](https://img.shields.io/github/v/release/trzsz/trzsz-ssh)](https://github.com/trzsz/trzsz-ssh/releases)
[![WebSite](https://img.shields.io/badge/WebSite-https%3A%2F%2Ftrzsz.github.io%2Fssh-blue?style=flat)](https://trzsz.github.io/ssh)
[![中文文档](https://img.shields.io/badge/%E4%B8%AD%E6%96%87%E6%96%87%E6%A1%A3-https%3A%2F%2Ftrzsz.github.io%2Fcn%2Fssh-blue?style=flat)](https://trzsz.github.io/cn/ssh)

## tssh 简介

Expand Down Expand Up @@ -416,9 +416,11 @@ _`~/` 代表 HOME 目录。在 Windows 中,请将下文的 `~/` 替换成 `C:\
- 需要在客户端( 本地电脑 )上安装 `lrzsz`,Windows 可以从 [lrzsz-win32](https://github.com/trzsz/lrzsz-win32/releases) 下载解压并加到 `PATH` 中,也可以如下安装:

```
scoop install https://trzsz.github.io/lrzsz.json
scoop install lrzsz
```
choco install lrzsz --version=0.12.21
```
choco install lrzsz
```
- 关于 `rz / sz` 进度条,己传大小和传输速度会有一点偏差,它的主要作用只是指示传输正在进行中。
Expand Down
10 changes: 6 additions & 4 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

An ssh client that supports [trzsz](https://trzsz.github.io/), supports searching and selecting servers for batch login.

Website: [https://trzsz.github.io/ssh](https://trzsz.github.io/ssh) ( English )  中文文档:[https://trzsz.github.io/cn/ssh](https://trzsz.github.io/cn/ssh)

[![MIT License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://choosealicense.com/licenses/mit/)
[![GitHub Release](https://img.shields.io/github/v/release/trzsz/trzsz-ssh)](https://github.com/trzsz/trzsz-ssh/releases)
[![WebSite](https://img.shields.io/badge/WebSite-https%3A%2F%2Ftrzsz.github.io%2Fssh-blue?style=flat)](https://trzsz.github.io/ssh)
[![中文文档](https://img.shields.io/badge/%E4%B8%AD%E6%96%87%E6%96%87%E6%A1%A3-https%3A%2F%2Ftrzsz.github.io%2Fcn%2Fssh-blue?style=flat)](https://trzsz.github.io/cn/ssh)

## Introduce

Expand Down Expand Up @@ -415,9 +415,11 @@ _`~/` represents the HOME directory. Please replace `~/` below with `C:\Users\yo
- `lrzsz` needs to be installed on the client ( local computer ). For Windows, you can download and unzip it from [lrzsz-win32](https://github.com/trzsz/lrzsz-win32/releases) and add it to `PATH`, or install it as follows:

```
scoop install https://trzsz.github.io/lrzsz.json
scoop install lrzsz
```
choco install lrzsz --version=0.12.21
```
choco install lrzsz
```
- About the progress, the transferred and speed are not precise. It just indicating that the transfer is in progress.
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[![MIT License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://choosealicense.com/licenses/mit/)
[![GitHub Release](https://img.shields.io/github/v/release/trzsz/trzsz-ssh)](https://github.com/trzsz/trzsz-ssh/releases)
[![WebSite](https://img.shields.io/badge/WebSite-https%3A%2F%2Ftrzsz.github.io%2Fssh-blue?style=flat)](https://trzsz.github.io/ssh)
[![中文文档](https://img.shields.io/badge/%E4%B8%AD%E6%96%87%E6%96%87%E6%A1%A3-https%3A%2F%2Ftrzsz.github.io%2Fcn%2Fssh-blue?style=flat)](https://trzsz.github.io/cn/ssh)

## Introduction

Expand All @@ -18,8 +20,8 @@ trzsz-ssh ( tssh ) works exactly like the openssh client. The following common f
| Multiplexing | `ControlMaster` `ControlPath` `ControlPersist` |
| SSH Agent | `-a` `-A` `ForwardAgent` `IdentityAgent` `SSH_AUTH_SOCK` |
| Known Hosts | `UserKnownHostsFile` `GlobalKnownHostsFile` `StrictHostKeyChecking` |
| Authentication | `PubkeyAuthentication` `PasswordAuthentication` `KbdInteractiveAuthentication` |
| Basic Login | `-l` `-p` `-i` `-F` `HostName` `Port` `User` `IdentityFile` `SendEnv` `SetEnv` |
| Authentication | `PubkeyAuthentication` `PasswordAuthentication` `KbdInteractiveAuthentication` |
| Port Forward | `-g` `-f` `-N` `-L` `-R` `-D` `LocalForward` `RemoteForward` `DynamicForward` `GatewayPorts` `ClearAllForwardings` |

## Extra Features
Expand Down Expand Up @@ -170,7 +172,7 @@ Welcome and thank you for considering contributing. We appreciate all forms of s
- Fork and clone the repository `https://github.com/trzsz/trzsz-ssh.git`.
- Make your changes just don't break or fix the unit tests `go test ./tssh`.
- Make your changes just ensure that the unit tests `go test ./tssh` pass.
- Build the binary `go build -o ./bin/ ./cmd/tssh` and test it `./bin/tssh`.
Expand Down

0 comments on commit f0e7ecc

Please sign in to comment.