From 5cb934af8c4cd94a54240e7606e02a769889d063 Mon Sep 17 00:00:00 2001
From: Kurisu <yukinococo@outlook.com>
Date: Thu, 29 Aug 2024 21:17:59 +0800
Subject: [PATCH] docs: update README documents.

---
 README.en.md | 57 ++++++++++++++++++++++++++++++----------------------
 README.md    | 48 ++++++++++++++++++++++++-------------------
 2 files changed, 60 insertions(+), 45 deletions(-)

diff --git a/README.en.md b/README.en.md
index 97bcb0c..797e66e 100644
--- a/README.en.md
+++ b/README.en.md
@@ -1,36 +1,45 @@
 # ssh-utils
+English | [简体中文](./README.md)
+<div align="center">
 
-#### Description
-ssh-utils is a tool for fast ssh connections.
+**ssh-utils is a command-line tool that helps you quickly establish SSH connections.**
 
-#### Software Architecture
-Software architecture description
+![demo](https://gitee.com/YukinoCoco/ssh-utils/raw/assets/assets/demo.gif)
 
-#### Installation
+</div>
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+#### Introduction
+When connecting to remote servers, entering commands for each connection can be time-consuming. As the number of machines and users increases, along with different passwords for each, the time cost becomes increasingly significant.  
 
-#### Instructions
+This tool provides a set of command-line utilities that allow you to select the server and user you want to connect to using arrow keys after executing the command, greatly reducing the time spent on inputting commands to connect to remote servers, making it convenient and efficient.
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+#### Installation Guide
 
-#### Contribution
+##### 1. Install via cargo
+```bash
+cargo install ssh-utils
+```
 
-1.  Fork the repository
-2.  Create Feat_xxx branch
-3.  Commit your code
-4.  Create Pull Request
+##### 2. Install from Release
+Download the executable file or installation package for your platform from the release page.
 
+##### 3. Install from source code
+```bash
+git clone https://gitee.com/openeuler/ssh-utils
+cd ssh-utils
+cargo build --release
+sudo cp target/release/ssh-utils /usr/bin/
+```
 
-#### Gitee Feature
+#### Usage Instructions
 
-1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
-2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
-3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
-4.  The most valuable open source project [GVP](https://gitee.com/gvp)
-5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
-6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+After installation, run the tool using the ssh-utils command. Once you've added server information, you can use the up and down arrow keys to select the server you want to connect to, and press Enter to start the connection.  
+
+You can use `ssh-copy-id` to copy your public key to the remote server. When adding server information, leave the password blank to use local key-based authentication. The key usage order is consistent with the default order of the OpenSSH `ssh` command.
+
+#### How to Contribute
+
+1. Fork this repository
+2. Create a new branch: Feat_xxx
+3. Commit your code
+4. Create a new Pull Request
\ No newline at end of file
diff --git a/README.md b/README.md
index 5c8af21..4b097e5 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,43 @@
 # ssh-utils
+简体中文 | [English](./README.en.md)
+<div align="center">
 
-#### 介绍
-ssh-utils is a tool for fast ssh connections.
+**ssh-utils 是一个帮助您快速建立 ssh 连接的命令行工具。**
+
+![demo](https://gitee.com/YukinoCoco/ssh-utils/raw/assets/assets/demo.gif)
 
-#### 软件架构
-软件架构说明
+</div>
 
+#### 介绍
+在连接远程服务器过程中，每次输入命令连接时，都会花费一些时间。随着机器和用户的增多，每个机器和用户密码的不同，时间成本耗费越来越多。  
+本工具提供一套命令行工具，执行后命令后可以通过上下箭头，选择想要连接的服务器和用户，大大缩短每次输入命令连接远程服务器的时间，方便又快捷。
 
 #### 安装教程
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+##### 1. 通过 cargo 安装
+```bash
+cargo install ssh-utils
+```
+
+##### 2. 通过 Release 安装
+从 release 页面下载对应平台的可执行文件或安装包安装。
+
+##### 3. 通过源码安装
+```bash
+git clone https://gitee.com/openeuler/ssh-utils
+cd ssh-utils
+cargo build --release
+sudo cp target/release/ssh-utils /usr/bin/
+```
 
 #### 使用说明
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+安装之后，使用 ssh-utils 命令运行工具。添加服务器信息后，您可以通过小键盘上下箭头选择想要连接的服务器，回车后开始连接。  
+你可以 `ssh-copy-id` 将公钥拷贝到远程服务器，添加服务器信息时，密码留空则使用本地的密钥连接，密钥的使用顺序同 OpenSSH `ssh` 命令的默认顺序一致。
 
 #### 参与贡献
 
 1.  Fork 本仓库
 2.  新建 Feat_xxx 分支
 3.  提交代码
-4.  新建 Pull Request
-
-
-#### 特技
-
-1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
-2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
-4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
-5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
-6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+4.  新建 Pull Request
\ No newline at end of file
-- 
Gitee