From 9b6d4c133dc3b4bd18f38a60cff02bddd70af4c4 Mon Sep 17 00:00:00 2001 From: Creeam <102713261+HaHaWTH@users.noreply.github.com> Date: Sat, 18 Jan 2025 07:30:48 -0800 Subject: [PATCH] Add Leaf docs to readme (#201) * [ci skip] Add doc badge * [ci skip] Documentation section --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7a72ec26..890fdd88 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![Github Releases](https://img.shields.io/badge/Download-Releases-blue?&style=for-the-badge&colorA=19201a&colorB=298046)](https://github.com/Winds-Studio/Leaf/releases)⠀ [![Github Actions Build](https://img.shields.io/github/actions/workflow/status/Winds-Studio/Leaf/build-1213.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) +[![Docs](https://img.shields.io/badge/Docs-docs.leafmc.one-blue?label=docs&style=for-the-badge&colorA=19201a&colorB=298046)](https://docs.leafmc.one) **Leaf** is a drop-in replacement for [Paper](https://papermc.io/) servers designed to remove some checks, customized and high-performance, built on top of [Gale](https://github.com/Dreeam-qwq/Gale) with optimizations and fixes from other forks. @@ -42,6 +43,9 @@ You can find latest successful build in [GitHub Action](https://github.com/Winds **Please note Java >= 21 is required.** +## 📄 Documentation +Documentation on how to use/configure Leaf: [docs.leafmc.one](https://docs.leafmc.one) + ## 📦 Building Building a Paperclip JAR for distribution: ```bash