docs: update documentation for installation and WriteFile usage

- Add installation instructions and Go version requirements to the documentation
- Fix typos related to argument naming and folder spelling
- Clarify and correct usage example for the WriteFile method
- Add a detailed WriteFile usage section and example in the Chinese documentation

Signed-off-by: appleboy <appleboy.tw@gmail.com>

Author: appleboy

README.md

@@ -32,6 +32,14 @@ This project is forked from [easyssh](https://github.com/hypersleep/easyssh) but
      192.168.1.5       121.1.2.3         10.10.29.68
 ```
 
+## Installation
+
+```bash
+go get github.com/appleboy/easyssh-proxy
+```
+
+**Requirements:** Go 1.24 or higher
+
 ## Usage
 
 You can see detailed examples of the `ssh`, `scp`, `Proxy`, and `stream` commands inside the [`examples`](./_examples/) folder.
@@ -245,7 +253,7 @@ func main() {
 }
 ```
 
-### WiteFile
+### WriteFile
 
 See [examples/writeFile/writeFile.go](./_examples/writeFile/writeFile.go)
 
@@ -268,8 +276,8 @@ func main() {
   reader := strings.NewReader(fileContents)
 
   // Write a file to the remote server using the writeFile command.
-  // Second arguement specifies the number of bytes to write to the server from the reader.
-  if err := client.WriteFile(reader, int64(len(fileContents)), "/home/user/foo.txt"); err != nil {
+  // Second argument specifies the number of bytes to write to the server from the reader.
+  if err := ssh.WriteFile(reader, int64(len(fileContents)), "/home/user/foo.txt"); err != nil {
     return fmt.Errorf("Error: failed to write file to client. error: %w", err)
   }
 }

README.zh-tw.md

@@ -30,6 +30,14 @@ easyssh-proxy 提供了一個用 Go 語言實現的一些 SSH 協議功能的簡
      192.168.1.5       121.1.2.3         10.10.29.68
 ```
 
+## 安裝
+
+```bash
+go get github.com/appleboy/easyssh-proxy
+```
+
+**需求：** Go 1.24 或更高版本
+
 ## 使用方法
 
 你可以在 [`examples`](./_examples/) 資料夾中看到 `ssh`、`scp`、`Proxy` 和 `stream` 命令的詳細範例。
@@ -157,7 +165,7 @@ func main() {
   }
 
   // Call Scp method with file you want to upload to remote server.
-  // Please make sure the `tmp` floder exists.
+  // Please make sure the `tmp` folder exists.
   err := ssh.Scp("/root/source.csv", "/tmp/target.csv")
 
   // Handle errors
@@ -242,3 +250,39 @@ func main() {
   }
 }
 ```
+
+### WriteFile
+
+參見 [examples/writeFile/writeFile.go](./_examples/writeFile/writeFile.go)
+
+```go
+func (ssh_conf *MakeConfig) WriteFile(reader io.Reader, size int64, etargetFile string) error
+```
+
+```go
+func main() {
+  // 使用遠程用戶名、伺服器地址和私鑰路徑創建 MakeConfig 實例。
+  ssh := &easyssh.MakeConfig{
+    Server:  "localhost",
+    User:    "drone-scp",
+    KeyPath: "./tests/.ssh/id_rsa",
+    Port:    "22",
+    Timeout: 60 * time.Second,
+  }
+
+  fileContents := "Example Text..."
+  reader := strings.NewReader(fileContents)
+
+  // 使用 writeFile 命令將文件寫入到遠程伺服器。
+  // 第二個參數指定從 reader 中寫入到伺服器的字節數。
+  if err := ssh.WriteFile(reader, int64(len(fileContents)), "/home/user/foo.txt"); err != nil {
+    return fmt.Errorf("錯誤：無法將文件寫入到客戶端。錯誤：%w", err)
+  }
+}
+```
+
+| 屬性        | 描述                                          |
+| ----------- | --------------------------------------------- |
+| reader      | 將讀取其內容並保存到伺服器的 `io.reader`      |
+| size        | 要從 `io.reader` 中讀取的字節數               |
+| etargetFile | 文件將被寫入到伺服器上的位置                   |