Upstream
/
Minestom
mirror of https://github.com/Minestom/Minestom.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added more usage info in README.md

This commit is contained in:
themode 2020-11-05 13:57:54 +01:00
parent 2c0f0a8f9e
commit 6ed1a7d462
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/README.md vendored
View File

@ -11,7 +11,7 @@ Minestom is an alternative to the popular Minecraft server API called Bukkit.
The main difference is that our implementation of the Notchian server does not contain any features by default!
However, we have a complete API which allows you to make anything possible with current spigot plugins.
This is a developer API not meant to be used by the end-users. Replacing Spigot/Paper with this will **not** work since we do not implement the Bukkit API
This is a developer API not meant to be used by the end-users. Replacing Spigot/Paper with this will **not** work since we do not implement the Bukkit API.
# Table of contents
- [Install](#install)
@ -32,6 +32,8 @@ Our own expanded version for Vanilla can be found [here](https://github.com/Mine
An example of how to use the Minestom library is available [here](/src/test/java/demo).
Alternatively you can check the official wiki [here](https://wiki.minestom.com/).
This mean you need to add Minestom as a dependency, add your code and compile by yourself.
# Why Minestom?
Minecraft evolved a lot since its release, most of the servers today do not take advantage of vanilla features and even have to struggle because of them. Our target audience is those who want to make a completely different server compared to default Minecraft gamemode such as survival or creative building.
The goal is to offer more performance for those who need it, Minecraft being single-threaded is the most important problem for them.