diff --git a/README.md b/README.md index c71da88..63202f5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ # McStatus-API 这是一个 Flask API,主要封装了 mcstatus 包,用于查询 Minecraft 服务器状态,支持Java和基岩,以及附带其他小特性! -## 📦安装/💻使用 +## 💻用法 + +此项目的页面模板正在筹备中,敬请等待! + +- `GET /java?ip= - (Required)` - 查询 Java 版服务器状态 +- `GET - /bedrock?ip= - (Required)` - 查询基岩版服务器状态 + +## 📦安装&▶启动 以下提到的方法 任选**其一** 即可 @@ -30,4 +37,16 @@ pdm run app.py pip install -r requirements.txt python app.py ``` - \ No newline at end of file + + +## 🖊下一步计划 +1. 添加配置文件 +2. 添加一个基于此项目的服务端(他可能只是一个API Caller,或者是一个Websocket服务器?) +服务端可以调用多个API,并将其返回的信息进行合并并输出,旨在用于检查不同地区的延迟 +3. 添加是否默认使用 SRV 解析的变量 + +## 📞 联系 + +TG群组:[点此加入](https://t.me/LoveMurasame) +吹水群:[1049319982](https://qm.qq.com/q/DfTsIDXuc8) +邮箱: \ No newline at end of file