From 9e87f664716b7c4cb50ea9267e882003236c0abd Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Thu, 4 Dec 2025 01:58:25 +0000
Subject: [PATCH] Add README.md

---
 README.en.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 132 insertions(+)
 create mode 100644 README.en.md
 create mode 100644 README.md

diff --git a/README.en.md b/README.en.md
new file mode 100644
index 0000000..67786b4
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,66 @@
+# Go Web Shell
+
+This is a Web Shell project developed in Go, designed to provide a simple, secure, and efficient web interface for executing remote shell commands.
+
+## Features
+
+- Execute shell commands via a web interface.
+- Supports multiple operating systems (Linux, macOS, Windows).
+- Secure authentication mechanism to prevent unauthorized access.
+- Clean and intuitive user interface for easy use.
+
+## Installation
+
+### Prerequisites
+
+- Go 1.16 or higher
+- Node.js (optional, for frontend build)
+
+### Installation Steps
+
+1. Clone the project locally:
+
+   ```bash
+   git clone https://gitee.com/mtygp/go-web-shell.git
+   cd go-web-shell
+   ```
+
+2. Install dependencies and build the project:
+
+   ```bash
+   go mod tidy
+   go build -o webshell
+   ```
+
+3. Start the service:
+
+   ```bash
+   ./webshell
+   ```
+
+   The service runs by default at `http://localhost:8080`.
+
+## Usage
+
+1. Open your browser and navigate to `http://localhost:8080`.
+2. Enter the shell command you wish to execute and click "Execute".
+3. View the command output.
+
+## Security Notice
+
+- Always configure the authentication mechanism to prevent unauthorized access.
+- It is recommended to use this tool only in a private network environment and avoid exposing it to the public internet.
+
+## Contribution Guidelines
+
+Contributions and improvements are welcome! Please follow these steps:
+
+1. Fork the project.
+2. Create a new branch: `git checkout -b feature/new-feature`
+3. Commit your changes: `git commit -am 'Add new feature'`
+4. Push the branch: `git push origin feature/new-feature`
+5. Submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ad7f4b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+# Go Web Shell
+
+这是一个基于 Go 语言开发的 Web Shell 项目，旨在提供一个简单、安全、高效的 Web 界面来执行远程 Shell 命令。
+
+## 功能特性
+
+- 通过 Web 界面执行 Shell 命令。
+- 支持多种操作系统（Linux、macOS、Windows）。
+- 安全认证机制，防止未授权访问。
+- 简洁的用户界面，易于使用。
+
+## 安装说明
+
+### 依赖环境
+
+- Go 1.16 或更高版本
+- Node.js（可选，用于前端构建）
+
+### 安装步骤
+
+1. 克隆项目到本地：
+
+   ```bash
+   git clone https://gitee.com/mtygp/go-web-shell.git
+   cd go-web-shell
+   ```
+
+2. 安装依赖并构建项目：
+
+   ```bash
+   go mod tidy
+   go build -o webshell
+   ```
+
+3. 启动服务：
+
+   ```bash
+   ./webshell
+   ```
+
+   默认服务运行在 `http://localhost:8080`。
+
+## 使用方法
+
+1. 打开浏览器访问 `http://localhost:8080`。
+2. 输入需要执行的 Shell 命令，点击执行。
+3. 查看命令执行结果。
+
+## 安全说明
+
+- 请务必配置安全认证机制，防止未授权访问。
+- 建议在内网环境中使用，避免暴露到公网。
+
+## 贡献指南
+
+欢迎贡献代码和改进！请遵循以下步骤：
+
+1. Fork 项目。
+2. 创建新分支：`git checkout -b feature/new-feature`
+3. 提交更改：`git commit -am 'Add new feature'`
+4. 推送分支：`git push origin feature/new-feature`
+5. 提交 Pull Request。
+
+## 许可证
+
+本项目使用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。
\ No newline at end of file
-- 
Gitee