From 869800b842d82c981406402e0d8341644cc21551 Mon Sep 17 00:00:00 2001
From: XAP3Y <github@xap3y.eu>
Date: Fri, 7 Jun 2024 17:59:08 +0200
Subject: [PATCH] Readme

---
 README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..46a64c9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,76 @@
+# SkullCreator
+
+## Fork of [SkullCreator](https://github.com/deanveloper/SkullCreator) with extra stuff
+
+The only difference is that it is written in Kotlin, and allows you to get <br>
+head from name or UUID online (using MojangAPI)
+
+## Download
+
+<details>
+<summary>Maven</summary>
+
+First, add JitPack to your repositories
+
+```xml
+<repository>
+    <id>jitpack.io</id>
+    <url>https://jitpack.io</url>
+  </repository>
+```
+
+Then add this as dependency
+
+```xml
+<dependency>
+    <groupId>com.github.xap3y</groupId>
+    <artifactId>SkullCreator</artifactId>
+    <version>b3fa7232c18f71b9d5e105aa68087f3b8efcbd50</version>
+    <scope>compile</scope>
+</dependency>
+```
+
+</details>
+
+
+<details>
+<summary>Gradle</summary>
+
+#### Soon!
+
+</details>
+
+## Usage
+
+> [!NOTE]\
+> Same as the original [SkullCreator](https://github.com/deanveloper/SkullCreator) only except the new stuff below
+
+
+### By Name (Online)
+
+`SkullCreator.itemFromNameOnline("XAP3Y")` returning `CompletableFuture<ItemStack>` <br>
+
+#### Example (Kotlin)
+```kotlin
+SkullCreator.itemFromNameOnline("XAP3Y").whenComplete { item, _ ->
+    player.inventory.addItem(item)
+}
+```
+
+### By UUID (Online)
+
+The argument has to be UUID in string. It doesn't matter if you put the UUID with dashed or not <br>
+`SkullCreator.itemFromUuidOnline("f1c3931e93d341258fdc9b1dc39bc4d6")` <br> 
+which also returns `CompletableFuture<ItemStack>`
+
+#### Example (Kotlin)
+```kotlin
+SkullCreator.itemFromUuidOnline("f1c3931e93d341258fdc9b1dc39bc4d6").whenComplete { item, _ ->
+    player.inventory.addItem(item)
+}
+```
+
+
+
+
+