From 4466c5d6ab597540143e2fbab4e6ec34168681f8 Mon Sep 17 00:00:00 2001
From: wangwei10061 <153692771@qq.com>
Date: Tue, 14 Oct 2025 21:26:39 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20'README.md'?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 38 +++++++++++++++++++++++++++++++++++---
 1 file changed, 35 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index f13ea26..a83f5ce 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,37 @@
-ReadMe 使用 markdown 语法，所以我们需要掌握基础的语法。
 
-markdown 的语法主要包括 标题、段落、链接、引用、代码，语法不复杂，初学者只要多写几次就能记住。
+# jwebssh
 
-下面是 GitHub 上两个关于 markdown 的项目，它们总结了我们需要的基础语法。
\ No newline at end of file
+基于 Web 的 SSH 终端客户端（Java 实现）。
+
+通过浏览器即可安全连接远程服务器，无需安装额外工具。
+
+## ✨ 特性
+
+- 纯 Java 后端（基于 Spring Boot + WebSocket）
+- 前端使用 xterm.js 实现终端渲染
+- 支持密码和私钥认证
+- 多会话标签管理
+- 响应式界面，适配桌面与移动设备
+
+## 🚀 快速启动
+
+```bash
+# 编译
+mvn clean package
+
+# 运行
+java -jar target/jwebssh.jar
+
+# 访问 http://localhost:8080
+```
+
+> 默认端口：8080，可通过 `--server.port=xxxx` 修改。
+
+## 🔒 安全提示
+
+- SSH 凭据仅在内存中使用，**不会保存到磁盘**。
+- 生产环境请务必配置 HTTPS 和访问控制。
+
+## 📄 开源协议
+
+MIT License