Replace boilerplate README with project-specific documentation

README.md

@@ -1,30 +1,47 @@
 # GameAPI
 
+[![Build](https://git.softwarerat.com/zlaura/GameAPI/actions/workflows/build.yml/badge.svg)](https://git.softwarerat.com/zlaura/GameAPI/actions)
 
-## Description
-open Source network development API for making minigames
+Open-source network development API for building Minecraft minigames on Paper. Provides shared building blocks — game state management, world handling, player prefixes, inventory/item builders, and common event listeners — so individual minigame plugins (GhostHunt, MLGRush, AlleGegenEinen, ...) don't reimplement the same scaffolding.
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+## Requirements
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+- Java 21
+- Maven
+- Paper API 1.20.1
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+## Key packages
+
+- `com.softwarerat.API.data.gameState` — `IGameState` / `GameStateManager` for lobby → ingame → ending state machines
+- `com.softwarerat.API.data.prefix` — `PrefixAPI`, scoreboard-team-based player prefixes
+- `com.softwarerat.API.data.world` — `WorldAPI`, world loading helpers
+- `com.softwarerat.API.builder` — `SpigotItem` / `SpigotInventory` fluent builders
+- `com.softwarerat.API.event.listener` — reusable listeners (join/quit/chat/build-break/spectator)
+
+## Building
+
+```bash
+mvn -B package
+```
+
+## Using it in another project
+
+GameAPI is 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>GameAPI</artifactId>
+    <version>1.6.4-SNAPSHOT</version>
+</dependency>
+```
+
+Add the registry as a repository (and matching server credentials in `settings.xml`) to resolve it.
 
-## Usage
-just take a look at [Usage of the API](usage.md)
 ## Support
-just text me on Discord: zLavra
 
-## Contributing
-comming in the Future
+Discord: zLavra
 
-## Authors and acknowledgment
-Laura/Softwarerat
 ## License
-For open source projects, say how it is licensed.
 
-## Project status
-in Continous development
+GPL-3.0 — see [LICENSE](LICENSE).