Skip to content

Commit 96237ae

Browse files
committed
docs: improve docs statements
1 parent 25d7e38 commit 96237ae

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ pip install -U maimai-py
3333

3434
For more, read the docs: https://maimai.turou.fun/.
3535

36-
If you don't want to use Python for development, you can also download the maimai.py client and call it via RESTful API.
36+
Additionally, you can [download the maimai.py client](https://github.com/TrueRou/maimai.py/releases) and develop using any programming language.
3737

3838
## Quickstart
3939

@@ -74,6 +74,6 @@ maimai.py provides a RESTful API client, which you can call maimai.py features v
7474

7575
The client is compiled using Nuitka, please download it from the [Releases](https://github.com/TrueRou/maimai.py/releases) page.
7676

77-
Our client supports Windows, MacOS, and Linux, please download the corresponding version according to your system.
77+
Our client supports Windows and Linux, please download the corresponding version according to your system.
7878

7979
For the client API documentation, please see: https://openapi.maimai.turou.fun/.

README_CN.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
支持从数据源查询歌曲、谱面、玩家信息、分数、Rating、姓名框、牌子进度.
1919

20-
另外, 支持联动微信 OpenID 获取玩家分数, 解析分数HTML, 并上传至数据源
20+
另外, 支持联动微信 OpenID 获取玩家分数, 解析分数HTML, 并上传至数据源.
2121

2222
## 使用方式
2323

@@ -33,7 +33,7 @@ pip install -U maimai-py
3333

3434
更多内容请查看文档: https://maimai.turou.fun/zh/.
3535

36-
如果您不想使用 Python 进行开发, 也可以下载 maimai.py 客户端, 通过 RESTful API 进行调用.
36+
另外, 您也可以[下载 maimai.py 客户端](https://github.com/TrueRou/maimai.py/releases), 使用任何编程语言进行开发.
3737

3838
## 快速开始
3939

@@ -74,6 +74,6 @@ maimai.py 提供了 RESTful API 客户端, 您可以通过任何语言通过HTTP
7474

7575
客户端使用 Nuitka 编译, 请在 [Releases](https://github.com/TrueRou/maimai.py/releases) 页面下载.
7676

77-
我们的客户端支持 Windows, MacOS, Linux, 请根据您的系统下载对应的版本.
77+
我们的客户端支持 Windows, Linux, 请根据您的系统下载对应的版本.
7878

7979
客户端API文档请查看: https://openapi.maimai.turou.fun/.

docs/client.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ maimai.py provides a RESTful API client that you can call using any language via
44

55
The client is compiled using Nuitka. Please download it from the [Releases](https://github.com/TrueRou/maimai.py/releases) page.
66

7-
Our client supports Windows, MacOS, and Linux. Please download the appropriate version for your system.
7+
Our client supports Windows and Linux. Please download the appropriate version for your system.
88

99
## Usage
1010

docs/zh/client.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# 客户端
22

3-
maimai.py 提供了 RESTful API 客户端, 您可以通过任何语言通过HTTP请求来调用 maimai.py 的特性.
3+
maimai.py 提供了 RESTful API 客户端, 您可以通过任何语言通过HTTP请求来调用 maimai.py 的特性
44

5-
客户端使用 Nuitka 编译, 请在 [Releases](https://github.com/TrueRou/maimai.py/releases) 页面下载.
5+
客户端使用 Nuitka 编译请在 [Releases](https://github.com/TrueRou/maimai.py/releases) 页面下载
66

7-
我们的客户端支持 Windows, MacOS, Linux, 请根据您的系统下载对应的版本.
7+
我们的客户端支持 Windows Linux请根据您的系统下载对应的版本
88

99
## 使用方式
1010

@@ -15,9 +15,9 @@ maimai.py 提供了 RESTful API 客户端, 您可以通过任何语言通过HTTP
1515

1616
## 关于文档
1717

18-
FastAPI 提供了自动生成的文档, 您可以通过访问 `http://127.0.0.1:8000/docs` 来查看文档和测试功能.
18+
FastAPI 提供了自动生成的文档您可以通过访问 `http://127.0.0.1:8000/docs` 来查看文档和测试功能
1919

20-
另外,我们也提供了可以在线预览的API文档,您可以通过 [这里](https://openapi.maimai.turou.fun/) 查看.
20+
另外,我们也提供了可以在线预览的API文档,您可以通过 [这里](https://openapi.maimai.turou.fun/) 查看
2121

2222
## 调用示例
2323

@@ -156,7 +156,7 @@ func main() {
156156

157157
## FastAPI集成
158158

159-
如果您希望在自己的 FastAPI 项目中集成 maimai.py, 您可以通过以下方式来导入 maimai.py 的所有路由。
159+
如果您希望在自己的 FastAPI 项目中集成 maimai.py您可以通过以下方式来导入 maimai.py 的所有路由。
160160

161161
```python
162162
from fastapi import FastAPI

0 commit comments

Comments
 (0)