update: readme.md

readme.md

@@ -13,30 +13,33 @@
 
 ## 主要特色
 
-- [x] 轻量简洁：Fastapi+Sqlite3+Vue2+ElementUI
-- [x] 轻松上传：复制粘贴，拖拽选择
-- [x] 多种类型：文本，文件
-- [x] 防止爆破：错误次数限制
-- [x] 防止滥用：IP限制上传次数
-- [x] 口令分享：随机口令，存取文件，自定义次数以及有效期
-- [x] 国际化：支持中文和英文
-- [x] 匿名分享：无需注册，无需登录
-- [x] 管理面板：查看所有文件，删除文件
-- [x] 一键部署：docker一键部署
-- [x] 自由拓展：S3协议、本地文件流，可根据需求在storage文件中新增存储引擎
-- [x] 简单明了：适合新手练手项目
-- [x] 终端下载：wget https://share.lanol.cn/share/select?code=83432
+- [x] **轻量简洁：** 使用Fastapi + Sqlite3 + Vue2 + ElementUI搭建
+- [x] **轻松上传：** 支持复制粘贴和拖拽选择
+- [x] **多种类型：** 支持文本和文件
+- [x] **防止爆破：** 错误次数限制
+- [x] **防止滥用：** IP限制上传次数
+- [x] **口令分享：** 随机口令，存取文件，自定义次数及有效期
+- [x] **国际化：** 支持中文和英文
+- [x] **匿名分享：** 无需注册，无需登录
+- [x] **管理面板：** 查看和删除文件
+- [x] **一键部署：** 支持Docker一键部署
+- [x] **自由拓展：** 支持S3协议和本地文件流，可根据需求在storage文件中新增存储引擎
+- [x] **简单明了：** 适合新手练手项目
+- [x] **终端下载：** 终端命令`wget https://share.lanol.cn/share/select?code=83432`
 
 ## 部署方式
 
 ### 1Panel一键部署
 
-应用商店->实用工具->FileCodeBox
+进入应用商店 -> 实用工具 -> FileCodeBox
 ![img_6.png](./.github/images/img_6.png)
-更新：容器->选择->更多->编辑->强制拉取镜像->确认
+**更新：** 容器 -> 选择 -> 更多 -> 编辑 -> 强制拉取镜像 -> 确认
+
 ### 宝塔应用商店一键部署
-貌似是1.6版本的
+
+目前版本为1.6
 ![img](https://img.065065.xyz/file/966c5239926f46e03bd91.png)
+
 ### Docker一键部署
 
 #### 2.0版本，完善中
@@ -47,16 +50,15 @@
 
 后台密码：`FileCodeBox2023`
 
-AMD & ARM
+*支持AMD & ARM*
 
-一键安装
+**一键安装**
 
 ```bash
 docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:beta
-
 ```
 
-一键更新
+**一键更新**
 
 ```bash
 docker pull lanol/filecodebox:beta && docker stop filecodebox && docker rm filecodebox && docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:beta
@@ -77,25 +79,24 @@ docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --n
 ### 更新方式
 
 ```bash
-// 更新
+// 更新容器
 docker pull lanol/filecodebox:beta
-// 停止容器并删除
+// 停止和删除容器
 docker stop filecodebox && docker rm filecodebox
 // 重新运行容器
 docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:latest
 ```
 
-### 1.6版本注意
+#### 1.6版本注意事项
 
-这一版改变比较大，如果出现问题可以尝试清空/opt/FileCodeBox目录，有问题欢迎反馈留言
-注意，如果是第一次安装，请查看docker日志获取初始密码和后台地址，参考指令
-后台本地文件列表，需要将服务器文件移动至目录/opt/FileCodeBox/data/locals，这样就可以显示了。
+本版变动较大，如遇问题可尝试清空/opt/FileCodeBox目录，有问题欢迎反馈。**注意：** 如为首次安装，请查看Docker日志以获取初始密码和后台地址，参考命令如下：
 
 ```bash
 docker logs filecodebox
-
 ```
 
+**后台本地文件列表**：需要将服务器文件移动至/opt/FileCodeBox/data/locals目录，这样才会显示。
+
 ## 预览
 
 ### 例站
@@ -106,35 +107,23 @@ docker logs filecodebox
 
 <table style="width:100%">
 <tr style="width: 100%">
-<td style="width: 50%">
-<img src="./.github/images/img.png" alt="寄文件">
-</td>
-<td style="width: 50%">
-<img src="./.github/images/img_1.png" alt="寄文件">
-</td>
+<td style="width: 50%"><img src="./.github/images/img.png" alt="寄文件"></td>
+<td style="width: 50%"><img src="./.github/images/img_1.png" alt="寄文件"></td>
 </tr>
 <tr style="width: 100%">
-<td style="width: 50%">
-<img src="./.github/images/img_2.png" alt="寄文件">
-</td>
-<td style="width: 50%">
-<img src="./.github/images/img_3.png" alt="寄文件">
-</td>
+<td style="width: 50%"><img src="./.github/images/img_2.png" alt="寄文件"></td>
+<td style="width: 50%"><img src="./.github/images/img_3.png" alt="寄文件"></td>
 </tr>
 <tr style="width: 100%">
-<td style="width: 50%">
-<img src="./.github/images/img_4.png" alt="寄文件">
-</td>
-<td style="width: 50%">
-<img src="./.github/images/img_5.png" alt="寄文件">
-</td>
+<td style="width: 50%"><img src="./.github/images/img_4.png" alt="寄文件"></td>
+<td style="width: 50%"><img src="./.github/images/img_5.png" alt="寄文件"></td>
 </tr>
 </table>
 
-## 配置文件（1.7及以下版本才需要）
+## 配置文件（适用于1.7及以下版本）
 
-如果需要修改配置，可以将该文件放在`/opt/FileCodeBox/`目录下，并命名为`.env`，然后重启容器即可。
-如果不是Docker，则需要在项目同目录下新建一个`data`文件夹，然后在创建`.env`文件
+需要修改配置时，将以下内容保存为`.env`文件放置在`/opt/FileCodeBox/`目录下，重启容器即可。
+若未使用Docker，则需在项目同目录下创建一个`data`文件夹，并在该文件夹内创建`.env`文件。
 
 ```dotenv
 # 端口
@@ -171,7 +160,7 @@ DESCRIPTION=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享
 KEYWORDS=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件
 # 存储引擎
 STORAGE_ENGINE=filesystem
-# 如果使用阿里云OSS服务的话需要额外创建如下参数：
+# 如果使用阿里云OSS服务需额外创建如下参数：
 # 阿里云账号AccessKey
 KeyId=阿里云账号AccessKey
 # 阿里云账号AccessKeySecret
@@ -182,7 +171,7 @@ OSS_ENDPOINT=阿里云OSS Bucket的地域节点
 BUCKET_NAME=阿里云OSS Bucket的BucketName
 ```
 
-## 状态
+## 项目状态
 
 ![Alt](https://repobeats.axiom.co/api/embed/7a6c92f1d96ee57e6fb67f0df371528397b0c9ac.svg "Repobeats analytics image")
 
@@ -192,12 +181,10 @@ BUCKET_NAME=阿里云OSS Bucket的BucketName
 
 ## 常见问题
 
-1. 413 Request Entity Too Large
-   Nginx限制：
-   找到自己主机的nginx.conf配置文件，打开
-   在http{}中加入 client_max_body_size 10m;
-   然后重启nginx
+1. *413 Request Entity Too Large*:  
+   Nginx限制解决方法：
+   打开主机的`nginx.conf`配置文件，在`http{}`中加入`client_max_body_size 10m;`，然后重启Nginx。
 
 ## 免责声明
 
-本项目开源仅供学习使用，不得用于任何违法用途，否则后果自负，与本人无关。使用请保留项目地址谢谢。
+本项目开源仅供学习使用，不得用于任何违法用途，否则后果自负，与本人无关。使用请保留项目地址，谢谢。