[ci skip] Update README.md

README.md

@@ -1,37 +1,42 @@
-# ForkTest - A Paper fork, using paperweight
+<img src="logo.webp" alt="Mirai Face" align="right">
+<div align="center">
+  <h1>Mirai</h1>
+  <h3>A powerful Minecraft Server Software coming from the future</h3>
+  <h4>Mirai is ❗under heavy development❗ and contributions are welcome!</h4>
 
-This is an example project, showcasing how to setup a fork of Paper (or any other fork using paperweight), using paperweight.
+[![Actions](https://img.shields.io/github/workflow/status/etil2jz/Mirai/Build)](https://github.com/etil2jz/Mirai/actions)
+</div>
 
-The files of most interest are
-- build.gradle.kts
-- settings.gradle.kts
-- gradle.properties
+## Features
 
-## Tasks
+- **30% faster hoppers** over Paper.
+- **Improved entity performance** from a reduction in ticking entity behavior based on how far away they are from the player.
+- **Reduced GC times & frequency** from removing useless allocations, which also improves CPU performance.
+- **Fast raytracing** which improves performance of any entity which utilizes line of sight, mainly Villagers.
+- **Built-in profiler** which has 0 performance hit and easy to read metrics for both server owners and developers.
+- Faster crafting, reduction in uselessly loaded chunks, faster entity ticking, faster block ticking, faster bat spawning, and more!
+- Plugin compatibility with Spigot & Paper plugins.
+- All metrics, bStats and the vanilla snooper included, are removed.
 
-```
-Paperweight tasks
------------------
-applyApiPatches
-applyPatches
-applyServerPatches
-cleanCache - Delete the project setup cache and task outputs.
-generateDevelopmentBundle
-paperclipJar - Build a runnable paperclip jar
-rebuildApiPatches
-rebuildPatches
-rebuildServerPatches
-reobfJar - Re-obfuscate the built jar to obf mappings
-runDev - Spin up a non-shaded non-remapped test server
-runReobf - Spin up a test server from the reobfJar output jar
-runShadow - Spin up a test server from the shadowJar archiveFile
+## Downloads
+The latest JAR file can be downloaded from the [release/1.17 branch](https://github.com/etil2jz/Mirai/raw/release/1.17/Mirai-1.17.1-R0.1-SNAPSHOT.jar). You can also clone this repository and build it yourself.
+
+If you are interested in making a fork, check out this template [here](https://github.com/TECHNOVE/MyAirplaneFork)!
+
+## Building
+
+If you want to avoid the patching system:
+
+```bash
+./gradlew clean applyPatches && ./gradlew build
 ```
 
-## Branches
+Otherwise, in order to distribute, you need a paperclip file:
 
-Each branch of this project represents an example:
+```bash
+./gradlew clean applyPatches && ./gradlew paperclipJar
+```
 
- - [`main` is the standard example](https://github.com/PaperMC/paperweight-examples/tree/main)
- - [`submodules` shows how paperweight can be applied on a fork using the more traditional git submodule system](https://github.com/PaperMC/paperweight-examples/tree/submodules)
- - [`mojangapi` shows how a fork could patch arbitrary non-git directories (such as `Paper-MojangAPI`)](https://github.com/PaperMC/paperweight-examples/tree/mojangapi)
- - [`submodules-mojang` shows the same as `mojangapi`, but on the git submodules setup from `submodules`](https://github.com/PaperMC/paperweight-examples/tree/submodules-mojangapi)
+## License
+Patches are licensed under GPL-3.0.  
+All other files are licensed under MIT.