Repo-Mirror/Leaf
9
0
Fork 0
mirror of https://github.com/Winds-Studio/Leaf.git synced 2025-12-19 15:09:25 +00:00
Code Issues Releases Activity

[ci skip] updated readme (#421)

Browse Source
This commit is contained in:
Taiyou
2025-07-23 02:23:30 +02:00
committed by GitHub
parent 394402fb64
commit 1f04a6dc59
2 changed files with 75 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@@ -1,6 +1,6 @@
<img src="public/image/leaf_banner.png" alt="Leaf"> <img src="public/image/leaf_banner.png" alt="Leaf">
<div align="center"> <div align="center">
[![Download](https://img.shields.io/badge/releases-blue?label=download&style=for-the-badge&colorA=19201a&colorB=298046)](https://www.leafmc.one/download)⠀ [![Download](https://img.shields.io/badge/releases-blue?label=download&style=for-the-badge&colorA=19201a&colorB=298046)](https://www.leafmc.one/download)⠀
[![Github Actions Build](https://img.shields.io/github/actions/workflow/status/Winds-Studio/Leaf/build-1218.yml?&style=for-the-badge&colorA=19201a&colorB=298046)](https://github.com/Winds-Studio/Leaf/actions)⠀ [![Github Actions Build](https://img.shields.io/github/actions/workflow/status/Winds-Studio/Leaf/build-1218.yml?&style=for-the-badge&colorA=19201a&colorB=298046)](https://github.com/Winds-Studio/Leaf/actions)⠀
[![Discord](https://img.shields.io/discord/1145991395388162119?label=discord&style=for-the-badge&colorA=19201a&colorB=298046)](https://discord.gg/gfgAwdSEuM) [![Discord](https://img.shields.io/discord/1145991395388162119?label=discord&style=for-the-badge&colorA=19201a&colorB=298046)](https://discord.gg/gfgAwdSEuM)
@@ -39,9 +39,7 @@
If you love our work, feel free to donate via our [Open Collective](https://opencollective.com/Winds-Studio) or [Dreeam's AFDIAN](https://afdian.com/a/Dreeam) :) If you love our work, feel free to donate via our [Open Collective](https://opencollective.com/Winds-Studio) or [Dreeam's AFDIAN](https://afdian.com/a/Dreeam) :)
## 📥 Download ## 📥 Download
Download Leaf from our [website](https://www.leafmc.one/download) or get latest build in [GitHub Action](https://github.com/Winds-Studio/Leaf/actions) Download Leaf from our [Website](https://www.leafmc.one/download) or get latest build in [GitHub Releases](https://github.com/Winds-Studio/Leaf/releases)
**Please note Java >= 21 is required.**
## 📄 Documentation ## 📄 Documentation
Documentation about how to use/configure Leaf: [www.leafmc.one/docs](https://www.leafmc.one/docs) Documentation about how to use/configure Leaf: [www.leafmc.one/docs](https://www.leafmc.one/docs)
@@ -52,7 +50,10 @@ Building a Paperclip JAR for distribution:
./gradlew applyAllPatches && ./gradlew createMojmapPaperclipJar ./gradlew applyAllPatches && ./gradlew createMojmapPaperclipJar
``` ```
## 🧪 API
## 📦 API
<details>
<summary>Click to expand</summary>
### Maven ### Maven
```xml ```xml
@@ -85,11 +86,10 @@ java {
toolchain.languageVersion.set(JavaLanguageVersion.of(21)) toolchain.languageVersion.set(JavaLanguageVersion.of(21))
} }
``` ```
</details>
## ⚖️ License ## ⚖️ License
Leaf is licensed under multiple open source licenses depending on upstream projects and other materials, Leaf is licensed under various open source licenses from its upstream projects. See [LICENSE.md](LICENSE.md) for full details.
see [LICENSE.md](LICENSE.md) for full license information.
## 📜 Credits ## 📜 Credits
Thanks to these projects below. Leaf includes some patches taken from them.<br> Thanks to these projects below. Leaf includes some patches taken from them.<br>
@@ -123,26 +123,34 @@ If these excellent projects hadn't existed, Leaf wouldn't have become great.
</details> </details>
## 🔥 Special Thanks ## 🔥 Special Thanks
[![Jianke Cloud Host](public/image/JiankeServer.jpg)](https://cloud.swordsman.com.cn/?i8ab42c) \
cloud of swordsman | 剑客云
If you want to find a cheaper, high performance, stable, lower latency host, then cloud of swordsman is a good choice! Registers and purchases in [here](https://cloud.swordsman.com.cn/?i8ab42c). <table>
<tr>
如果你想找一个低价高性能、低延迟的云服务商，剑客云是个不错的选择！你可以在 [这里](https://cloud.swordsman.com.cn/?i8ab42c) 注册。 <td width="50%" align="center">
<a href="https://cloud.swordsman.com.cn/?i8ab42c">
--- <img src="public/image/JiankeServer.jpg" alt="Jianke Cloud Host" width="250">
[![雨云](public/image/RainYun.jpg)](https://www.rainyun.com/NzE2NTc1_) \ </a>
RainYun | 雨云 <br>
<b>cloud of swordsman | 剑客云</b>
Global multi-line routing with cloud storage. Refund available within 7 days. Reliable uptime and expert support. RainYun — stable, cost-effective, and ready for fast cloud deployment. Visit [RainYun]([雨云](https://www.rainyun.com/NzE2NTc1_)) <p>If you want to find a cheaper, high performance, stable, lower latency host, then cloud of swordsman is a good choice! Registers and purchases in <a href="https://cloud.swordsman.com.cn/?i8ab42c">here</a>.</p>
<p>如果你想找一个低价高性能、低延迟的云服务商，剑客云是个不错的选择！你可以在 <a href="https://cloud.swordsman.com.cn/?i8ab42c">这里</a> 注册。</p>
国际多线路选择，配套云存储 — 购买服务后七天内不满意可以申请退订，强大的技术支持团队和高在线率客服。雨云云服务器，用稳定和性价比，助力您快速上云。点击前往 [雨云](https://www.rainyun.com/NzE2NTc1_)。 </td>
<td width="50%" align="center">
--- <a href="https://www.rainyun.com/NzE2NTc1_">
![YourKit](https://www.yourkit.com/images/yklogo.png) \ <img src="public/image/RainYun.jpg" alt="雨云" width="250">
</a>
YourKit supports open source projects with innovative and intelligent tools <br>
for monitoring and profiling Java and .NET applications. <b>RainYun | 雨云</b>
YourKit is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/), <p>Global multi-line routing with cloud storage. Refund available within 7 days. Reliable uptime and expert support. RainYun — stable, cost-effective, and ready for fast cloud deployment. Visit <a href="https://www.rainyun.com/NzE2NTc1_">RainYun</a>.</p>
[YourKit .NET Profiler](https://www.yourkit.com/dotnet-profiler/), <p>国际多线路选择，配套云存储 — 购买服务后七天内不满意可以申请退订，强大的技术支持团队和高在线率客服。雨云云服务器，用稳定和性价比，助力您快速上云。点击前往 <a href="https://www.rainyun.com/NzE2NTc1_">雨云</a>。</p>
and [YourKit YouMonitor](https://www.yourkit.com/youmonitor/). </td>
</tr>
<tr>
<td colspan="2" align="center">
<a href="https://www.yourkit.com/">
<img src="https://www.yourkit.com/images/yklogo.png" alt="YourKit" width="300">
</a>
<p>YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of <a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>, <a href="https://www.yourkit.com/dotnet-profiler/">YourKit .NET Profiler</a>, and <a href="https://www.yourkit.com/youmonitor/">YourKit YouMonitor</a>.</p>
</td>
</tr>
</table>

66
public/readme/README_CN.md
View File

@@ -1,3 +1,4 @@
<img src="../image/leaf_banner.png" alt="Leaf"> <img src="../image/leaf_banner.png" alt="Leaf">
<div align="center"> <div align="center">
@@ -39,9 +40,7 @@
如果您喜欢我们的工作，欢迎通过我们的 [Open Collective](https://opencollective.com/Winds-Studio) 或 [Dreeam 的爱发电](https://afdian.com/a/Dreeam) 进行赞助 :) 如果您喜欢我们的工作，欢迎通过我们的 [Open Collective](https://opencollective.com/Winds-Studio) 或 [Dreeam 的爱发电](https://afdian.com/a/Dreeam) 进行赞助 :)
## 📥 下载 ## 📥 下载
从我们的 [官网](https://www.leafmc.one/zh/download) 下载 Leaf，或在 [GitHub Action](https://github.com/Winds-Studio/Leaf/actions) 获取最新构建版本 从我们的 [官网](https://www.leafmc.one/zh/download) 下载 Leaf，或在 [GitHub Releases](https://github.com/Winds-Studio/Leaf/releases) 获取最新构建版本
**请注意需要 Java 21 以上。**
## 📄 文档 ## 📄 文档
关于如何使用/配置 Leaf 的文档：[www.leafmc.one/zh/docs](https://www.leafmc.one/zh/docs) 关于如何使用/配置 Leaf 的文档：[www.leafmc.one/zh/docs](https://www.leafmc.one/zh/docs)
@@ -52,7 +51,9 @@
./gradlew applyAllPatches && ./gradlew createMojmapPaperclipJar ./gradlew applyAllPatches && ./gradlew createMojmapPaperclipJar
``` ```
## 🧪 API ## 📦 API
<details>
<summary>点击展开</summary>
### Maven ### Maven
```xml ```xml
@@ -85,11 +86,10 @@ java {
toolchain.languageVersion.set(JavaLanguageVersion.of(21)) toolchain.languageVersion.set(JavaLanguageVersion.of(21))
} }
``` ```
</details>
## ⚖️ 许可证 ## ⚖️ 许可证
Leaf 根据其上游项目及其他材料，采用多种开源许可证授权， Leaf 根据其上游项目采用多种开源许可证授权。请参阅 [LICENSE.md](../../LICENSE.md) 了解完整的详细信息。
请参阅 [LICENSE.md](../../LICENSE.md) 获取完整的许可信息。
## 📜 致谢 ## 📜 致谢
感谢以下项目。Leaf 包含了一些取自这些项目的补丁。<br> 感谢以下项目。Leaf 包含了一些取自这些项目的补丁。<br>
@@ -123,25 +123,33 @@ Leaf 根据其上游项目及其他材料，采用多种开源许可证授权，
</details> </details>
## 🔥 特别感谢 ## 🔥 特别感谢
[![Jianke Cloud Host](../image/JiankeServer.jpg)](https://cloud.swordsman.com.cn/?i8ab42c) \ <table>
剑客云 | cloud of swordsman <tr>
<td width="50%" align="center">
如果你想找一个低价高性能、低延迟的云服务商，剑客云是个不错的选择！你可以在 [这里](https://cloud.swordsman.com.cn/?i8ab42c) 注册。 <a href="https://cloud.swordsman.com.cn/?i8ab42c">
<img src="../image/JiankeServer.jpg" alt="Jianke Cloud Host" width="250">
If you want to find a cheaper, high performance, stable, lower latency host, then cloud of swordsman is a good choice! Registers and purchases in [here](https://cloud.swordsman.com.cn/?i8ab42c). </a>
<br>
--- <b>剑客云 | cloud of swordsman</b>
[![雨云](../image/RainYun.jpg)](https://www.rainyun.com/NzE2NTc1_) \ <p>如果你想找一个低价高性能、低延迟的云服务商，剑客云是个不错的选择！你可以在 <a href="https://cloud.swordsman.com.cn/?i8ab42c">这里</a> 注册。</p>
雨云 | RainYun <p>If you want to find a cheaper, high performance, stable, lower latency host, then cloud of swordsman is a good choice! Registers and purchases in <a href="https://cloud.swordsman.com.cn/?i8ab42c">here</a>.</p>
</td>
国际多线路选择，配套云存储 — 购买服务后七天内不满意可以申请退订，强大的技术支持团队和高在线率客服。雨云云服务器，用稳定和性价比，助力您快速上云。点击前往 [雨云](https://www.rainyun.com/NzE2NTc1_)。 <td width="50%" align="center">
<a href="https://www.rainyun.com/NzE2NTc1_">
Global multi-line routing with cloud storage. Refund available within 7 days. Reliable uptime and expert support. RainYun — stable, cost-effective, and ready for fast cloud deployment. Visit [RainYun]([雨云](https://www.rainyun.com/NzE2NTc1_)) <img src="../image/RainYun.jpg" alt="雨云" width="250">
</a>
--- <br>
![YourKit](https://www.yourkit.com/images/yklogo.png) \ <b>雨云 | RainYun</b>
<p>国际多线路选择，配套云存储 — 购买服务后七天内不满意可以申请退订，强大的技术支持团队和高在线率客服。雨云云服务器，用稳定和性价比，助力您快速上云。点击前往 <a href="https://www.rainyun.com/NzE2NTc1_">雨云</a>。</p>
YourKit 通过创新和智能的工具支持开源项目，用于监控和分析 Java 和 .NET 应用程序。 <p>Global multi-line routing with cloud storage. Refund available within 7 days. Reliable uptime and expert support. RainYun — stable, cost-effective, and ready for fast cloud deployment. Visit <a href="https://www.rainyun.com/NzE2NTc1_">RainYun</a>.</p>
YourKit 是 [YourKit Java Profiler](https://www.yourkit.com/java/profiler/)、 </td>
[YourKit .NET Profiler](https://www.yourkit.com/dotnet-profiler/) 和 </tr>
[YourKit YouMonitor](https://www.yourkit.com/youmonitor/) 的创造者。 <tr>
<td colspan="2" align="center">
<a href="https://www.yourkit.com/">
<img src="https://www.yourkit.com/images/yklogo.png" alt="YourKit" width="300">
</a>
<p>YourKit 通过创新和智能的工具支持开源项目，用于监控和分析 Java 和 .NET 应用程序。YourKit 是 <a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>、<a href="https://www.yourkit.com/dotnet-profiler/">YourKit .NET Profiler</a> 和 <a href="https://www.yourkit.com/youmonitor/">YourKit YouMonitor</a> 的创造者。</p>
</td>
</tr>
</table>