diff --git a/README.md b/README.md index 9f09a7f..b383290 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,34 @@

HologramAPI

+
+ Version +
License -Version +Version +Version jitpack + +
-## Installation +# Installation -- Download .jar from the [latest release](https://github.com/MaximFiedler/HologramAPI/releases) -- Upload it to your server (plugins folder) +- Download HologramAPI-[version]**.jar** file from the [latest release](https://github.com/MaximFiedler/HologramAPI/releases) +- Upload the HologramAPI-[version]**.jar** file on your server (_yourserver/**plugins**_ folder) - Add the plugin as a dependency to your plugin and use it -Gradle +**Gradle installation** ``` repositories { maven { url 'https://jitpack.io' } } dependencies { - implementation 'com.github.MaximFiedler:HologramAPI:1.0.4' + implementation 'com.github.MaximFiedler:HologramAPI:1.1.1' } ``` -Maven +**Maven installation** ``` jitpack.io @@ -32,32 +38,13 @@ Maven com.github.MaximFiedler HologramAPI - 1.0.4 + 1.1.1 ``` -## Getting started - -Create a hologram - -```java -TextHologram hologram = new TextHologram("holo") - .setText("Hello world!") - .setTextShadow(true) - .setSize(new Vector3f(2,2,2)) - .spawn(Bukkit.getWorld("world").getSpawnLocation()); -``` - -Remove all holograms with a specific ID - -```java -HologramAPI.getHologramAPI().removeAllHologramsByID("YOUR_ID"); -``` - -Get all holograms with the same ID as a list - -```java -List holograms = HologramAPI.getHologramAPI().getHologramsByID("YOUR_ID"); -``` +# Wiki +Code examples & more +https://github.com/MaximFiedler/HologramAPI/wiki/Getting-started -I did not test the api yet so if you find any bugs please open an issue +# Example/Showcase Plugin +https://github.com/MaximFiedler/ExampleHologramPlugin