fix docs (#969)

* fix: correct typos and update URLs in README.md - Corrected "Savlo" to "Salvo" - Changed "offical" to "official" - Updated the URL for Example Projects - Improved the sentence "This is official crate" to "This is an official crate" * fix: correct mixed punctuation in README files - Standardized punctuation marks in `README.md` - Standardized punctuation marks in `README.zh-hans.md` - Standardized punctuation marks in `README.zh-hant.md` * fix typo * fix: correct mixed punctuation in README files
salvo-rs · Nov 1, 2024 · 4e269a5 · 4e269a5
1 parent a59a64e
commit 4e269a5
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -281,7 +281,7 @@ You can use [salvo-cli](https://github.com/salvo-rs/salvo-cli) to create a new S
 cargo install salvo-cli
 ```
 
-#### create a new salvo project
+#### create a new Salvo project
 
 ```bash
 salvo new project_name
@@ -316,8 +316,7 @@ Benchmark testing result can be found from here:
 
 ## ☕ Donate
 
-Salvo is an open source project. If you want to support Salvo, you can ☕ [**buy me a coffee here
-**](https://ko-fi.com/chrislearn).
+Salvo is an open source project. If you want to support Salvo, you can ☕ [**buy me a coffee here**](https://ko-fi.com/chrislearn).
 
 ## ⚠️ License
 

diff --git a/README.osc.md b/README.osc.md
@@ -51,7 +51,7 @@ Salvo(赛风) 是一个极其简单且功能强大的 Rust Web 后端框架。
 
 ## ⚡️ 快速开始
 
-你可以查看[实例代码](https://github.com/salvo-rs/salvo/tree/main/examples), 或者访问[官网](https://salvo.rs).
+你可以查看[实例代码](https://github.com/salvo-rs/salvo/tree/main/examples), 或者访问[官网](https://salvo.rs)。
 
 ### 支持 ACME 自动获取证书和 HTTP3 的 Hello World
 
@@ -79,8 +79,7 @@ async fn main() {
 
 ### 中间件
 
-Salvo 中的中间件其实就是 Handler, 没有其他任何特别之处。**所以书写中间件并不需要像其他某些框架需要掌握泛型关联类型等知识。
-只要你会写函数就会写中间件，就是这么简单!!!**
+Salvo 中的中间件其实就是 Handler, 没有其他任何特别之处。**所以书写中间件并不需要像其他某些框架需要掌握泛型关联类型等知识。只要你会写函数就会写中间件，就是这么简单!!!**
 
 ```rust
 use salvo::http::header::{self, HeaderValue};
@@ -145,9 +144,9 @@ Router::new()
     );
 ```
 
-`<id>`匹配了路径中的一个片段，正常情况下文章的的 `id`只是一个数字，这是我们可以使用正则表达式限制制 `id`的匹配规则，`r"<id:/\d+/>"`.
+`<id>`匹配了路径中的一个片段，正常情况下文章的的 `id`只是一个数字，这是我们可以使用正则表达式限制制 `id`的匹配规则，`r"<id:/\d+/>"`。
 
-还可以通过 `<**>`, `<*+>` 或者 `<*?>`匹配所有剩余的路径片段。为了代码易读性性强些，也可以添加适合的名字，让路径语义更清晰，比如：: `<**file_path>`.
+还可以通过 `<**>`, `<*+>` 或者 `<*?>`匹配所有剩余的路径片段。为了代码易读性性强些，也可以添加适合的名字，让路径语义更清晰，比如：: `<**file_path>`。
 
 有些用于匹配路径的正则表达式需要经常被使用，可以将它事先注册，比如 GUID:
 
@@ -297,7 +296,7 @@ cd examples
 cargo run --bin example-basic-auth
 ```
 
-您可以使用任何你想运行的示例名称替代这里的 `basic-auth`.
+您可以使用任何你想运行的示例名称替代这里的 `basic-auth`。
 
 ## 🚀 性能
 
@@ -315,7 +314,7 @@ Benchmark 测试结果可以从这里查看：
 
 ## ☕ 捐助
 
-`Salvo`是一个开源项目，如果想支持本项目，可以 ☕ [**请我喝杯咖啡**](https://ko-fi.com/chrislearn).
+`Salvo`是一个开源项目，如果想支持本项目，可以 ☕ [**请我喝杯咖啡**](https://ko-fi.com/chrislearn)。
 <p style="text-align: center;">
 <img src="https://salvo.rs/images/alipay.png" alt="Alipay" width="180"/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="https://salvo.rs/images/weixin.png" alt="Weixin" width="180"/>
 </p>

diff --git a/README.zh-hans.md b/README.zh-hans.md
@@ -46,12 +46,12 @@ Salvo(赛风) 是一个极其简单且功能强大的 Rust Web 后端框架。
 - 集成 Multipart 表单处理;
 - 支持 WebSocket, WebTransport;
 - 支持 OpenAPI;
-- 支持 Acme, 自动从 [let's encrypt](https://letsencrypt.org/)获取 TLS 证书。.
+- 支持 Acme, 自动从 [let's encrypt](https://letsencrypt.org/)获取 TLS 证书。
 - 支持 Tower Service 和 Layer.
 
 ## ⚡️ 快速开始
 
-你可以查看[实例代码](https://github.com/salvo-rs/salvo/tree/main/examples), 或者访问[官网](https://salvo.rs).
+你可以查看[实例代码](https://github.com/salvo-rs/salvo/tree/main/examples), 或者访问[官网](https://salvo.rs)。
 
 ### 支持 ACME 自动获取证书和 HTTP3 的 Hello World
 
@@ -79,8 +79,7 @@ async fn main() {
 
 ### 中间件
 
-Salvo 中的中间件其实就是 Handler, 没有其他任何特别之处。**所以书写中间件并不需要像其他某些框架需要掌握泛型关联类型等知识。
-只要你会写函数就会写中间件，就是这么简单!!!**
+Salvo 中的中间件其实就是 Handler, 没有其他任何特别之处。**所以书写中间件并不需要像其他某些框架需要掌握泛型关联类型等知识。只要你会写函数就会写中间件，就是这么简单!!!**
 
 ```rust
 use salvo::http::header::{self, HeaderValue};
@@ -99,7 +98,7 @@ async fn add_header(res: &mut Response) {
 Router::new().hoop(add_header).get(hello)
 ```
 
-这就是一个简单的中间件，它向 `Response` 的头部添加了 `Header`, 查看[完整源码](https://github.com/salvo-rs/salvo/blob/main/examples/middleware-add-header/src/main.rs).
+这就是一个简单的中间件，它向 `Response` 的头部添加了 `Header`, 查看[完整源码](https://github.com/salvo-rs/salvo/blob/main/examples/middleware-add-header/src/main.rs)。
 
 ### 可链式书写的树状路由系统
 
@@ -145,9 +144,9 @@ Router::new()
     );
 ```
 
-`<id>`匹配了路径中的一个片段，正常情况下文章的的 `id`只是一个数字，这是我们可以使用正则表达式限制制 `id`的匹配规则，`r"<id:/\d+/>"`.
+`<id>`匹配了路径中的一个片段，正常情况下文章的的 `id`只是一个数字，这是我们可以使用正则表达式限制制 `id`的匹配规则，`r"<id:/\d+/>"`。
 
-还可以通过 `<**>`, `<*+>` 或者 `<*?>`匹配所有剩余的路径片段。为了代码易读性性强些，也可以添加适合的名字，让路径语义更清晰，比如：: `<**file_path>`.
+还可以通过 `<**>`, `<*+>` 或者 `<*?>`匹配所有剩余的路径片段。为了代码易读性性强些，也可以添加适合的名字，让路径语义更清晰，比如：: `<**file_path>`。
 
 有些用于匹配路径的正则表达式需要经常被使用，可以将它事先注册，比如 GUID:
 
@@ -168,7 +167,7 @@ Router::with_path("<id:guid>").get(index)
 
 ### 文件上传
 
-可以通过 `Request` 中的 `file`异步获取上传的文件：:
+可以通过 `Request` 中的 `file`异步获取上传的文件：
 
 ```rust
 #[handler]
@@ -280,7 +279,7 @@ Salvo CLI 是一个命令行工具，可以简化创建新的 Salvo 项目的过
 cargo install salvo-cli
 ```
 
-#### 创建一个 salvo 项目
+#### 创建一个 Salvo 项目
 
 ```bash
 salvo new project_name
@@ -297,7 +296,7 @@ cd examples
 cargo run --bin example-basic-auth
 ```
 
-您可以使用任何你想运行的示例名称替代这里的 `basic-auth`.
+您可以使用任何你想运行的示例名称替代这里的 `basic-auth`。
 
 ## 🚀 性能
 
@@ -315,7 +314,7 @@ Benchmark 测试结果可以从这里查看：
 
 ## ☕ 捐助
 
-`Salvo`是一个开源项目，如果想支持本项目，可以 ☕ [**请我喝杯咖啡**](https://ko-fi.com/chrislearn).
+`Salvo`是一个开源项目，如果想支持本项目，可以 ☕ [**请我喝杯咖啡**](https://ko-fi.com/chrislearn)。
 <p style="text-align: center;">
 <img src="https://salvo.rs/images/alipay.png" alt="Alipay" width="180"/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="https://salvo.rs/images/weixin.png" alt="Weixin" width="180"/>
 </p>

diff --git a/README.zh-hant.md b/README.zh-hant.md
@@ -51,7 +51,7 @@ Salvo(賽風) 是一個極其簡單且功能強大的 Rust Web 後端框架。
 
 ## ⚡️ 快速開始
 
-你可以查看[實例代碼](https://github.com/salvo-rs/salvo/tree/main/examples), 或者訪問[官網](https://salvo.rs).
+你可以查看[實例代碼](https://github.com/salvo-rs/salvo/tree/main/examples), 或者訪問[官網](https://salvo.rs)。
 
 ### 支持 ACME 自動獲取證書和 HTTP3 的 Hello World
 
@@ -79,8 +79,7 @@ async fn main() {
 
 ### 中間件
 
-Salvo 中的中間件其實就是 Handler, 冇有其他任何特別之處。**所以書寫中間件並不需要像其他某些框架需要掌握泛型關聯類型等知識。
-隻要你會寫函數就會寫中間件，就是這麼簡單!!!**
+Salvo 中的中間件其實就是 Handler, 冇有其他任何特別之處。**所以書寫中間件並不需要像其他某些框架需要掌握泛型關聯類型等知識。隻要你會寫函數就會寫中間件，就是這麼簡單!!!**
 
 ```rust
 use salvo::http::header::{self, HeaderValue};
@@ -99,7 +98,7 @@ async fn add_header(res: &mut Response) {
 Router::new().hoop(add_header).get(hello)
 ```
 
-這就是一個簡單的中間件，它嚮 `Response` 的頭部添加了 `Header`, 查看[完整源碼](https://github.com/salvo-rs/salvo/blob/main/examples/middleware-add-header/src/main.rs).
+這就是一個簡單的中間件，它嚮 `Response` 的頭部添加了 `Header`, 查看[完整源碼](https://github.com/salvo-rs/salvo/blob/main/examples/middleware-add-header/src/main.rs)。
 
 ### 可鏈式書寫的樹狀路由係統
 
@@ -145,9 +144,9 @@ Router::new()
     );
 ```
 
-`<id>`匹配了路徑中的一個片段，正常情況下文章的的 `id`隻是一個數字，這是我們可以使用正則錶達式限製製 `id`的匹配規則，`r"<id:/\d+/>"`.
+`<id>`匹配了路徑中的一個片段，正常情況下文章的的 `id`隻是一個數字，這是我們可以使用正則錶達式限製製 `id`的匹配規則，`r"<id:/\d+/>"`。
 
-還可以通過 `<**>`, `<*+>` 或者 `<*?>`匹配所有剩餘的路徑片段。為了代碼易讀性性強些，也可以添加適合的名字，讓路徑語義更清晰，比如：: `<**file_path>`.
+還可以通過 `<**>`, `<*+>` 或者 `<*?>`匹配所有剩餘的路徑片段。為了代碼易讀性性強些，也可以添加適合的名字，讓路徑語義更清晰，比如：: `<**file_path>`。
 
 有些用於匹配路徑的正則錶達式需要經常被使用，可以將它事先註冊，比如 GUID:
 
@@ -280,7 +279,7 @@ Salvo CLI 是一個命令行工具，可以簡化創建新的 Salvo 項目的過
 cargo install salvo-cli
 ```
 
-#### 創建一個新的 salvo 項目
+#### 創建一個新的 Salvo 項目
 
 ```bash
 salvo new project_name
@@ -290,14 +289,15 @@ ___
 
 ### 更多示例
 
-您可以從 [examples](./examples/)文件夾下查看更多示例代碼，您可以通過以下命令運行這些示例：：
+您可以從 [examples](./examples/)文件夾下查看更多示例代碼，您可以通過以下命令運行這些示例：
+
 
 ```bash
 cd examples
 cargo run --bin example-basic-auth
 ```
 
-您可以使用任何你想運行的示例名稱替代這裏的 `basic-auth`.
+您可以使用任何你想運行的示例名稱替代這裏的 `basic-auth`。
 
 ## 🚀 性能
 
@@ -315,7 +315,7 @@ Benchmark 測試結果可以從這裏查看：
 
 ## ☕ 捐助
 
-`Salvo`是一個開源項目，如果想支持本項目，可以 ☕ [**請我喝杯咖啡**](https://ko-fi.com/chrislearn).
+`Salvo`是一個開源項目，如果想支持本項目，可以 ☕ [**請我喝杯咖啡**](https://ko-fi.com/chrislearn)。
 <p style="text-align: center;">
 <img src="https://salvo.rs/images/alipay.png" alt="Alipay" width="180"/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="https://salvo.rs/images/weixin.png" alt="Weixin" width="180"/>
 </p>