Replace boilerplate README with project-specific documentation

README.md

@@ -1,43 +1,35 @@
 # HomesAPI
-### initialisierung des Basis API Codes
 
-```java 
-        public void onEnable(){
-        Bansystem bansystem = new Bansystem();
-        bansystem.enableAPI("Benutzer","Passwort","Host","Datenbank");
-        ban = bansystem.getBan();
-        }
- ```     
+[![Build](https://git.softwarerat.com/zlaura/HomesAPI/actions/workflows/build.yml/badge.svg)](https://git.softwarerat.com/zlaura/HomesAPI/actions)
 
-## Verwendung des Home Systems:
-### erstellen eines Homes
-````java
-Homes home;    
-public void addHome(PlayerHome p){
-    //erstellt anhand der PlayerHome informationen ein Home
-    home.createNewHome(p);
-}
+A Paper API library providing a per-player homes system (create/list/teleport-to named homes), backed by YAML storage.
 
-````
+## Requirements
 
-### alle Homes eines Spielers holen
+- Java 18
+- Maven
+- Paper API 1.21.11
 
-````java
-Homes home;
-public ArrayList<String> getHomes{
-    ArrayList<String> homes = new ArrayList<>();
-    //erstellt eine ArrayList mit den HomeNames
-    home.getPlayerHome.forEach(h -> {homes.add(h.getName)});
-    return homes;
-}
-````
+## Building
 
-### ein Home eines Spielers anhand des Namens holen
+```bash
+mvn -B package
+```
 
-````java
-Homes home;
-public String getHomeWorld(String name){
-    home.getHomeByName(name);
-    return home.getWorld;
-}
-````
+## Using it in another project
+
+Published as a Maven snapshot to the private registry at `https://git.softwarerat.com/api/packages/zlaura/maven`:
+
+```xml
+<dependency>
+    <groupId>com.softwarerat</groupId>
+    <artifactId>HomesAPI</artifactId>
+    <version>1.3-SNAPSHOT</version>
+</dependency>
+```
+
+Used by [SMPCore](https://git.softwarerat.com/zlaura/SMPCore).
+
+## License
+
+No license file is present in this repository; all rights reserved by the author unless stated otherwise.