fix marketing: add marketing stuff and fix little thins

Author: superstrellaa

README.md

@@ -1,10 +1,134 @@
-# StorageManager API
+<p align="center">
+  <img src="./src/main/resources/assets/storagemanager-api/icon.png" width="128" alt="StorageManager API Icon"/>
+</p>
 
-The StorageManager API provides a set of functions to manage and interact with different storage systems. It allows users to perform operations such as creating, reading, updating, and deleting data in a structured manner.
+<h1 align="center">
+StorageManager API
+</h1>
+
+<p align="center">
+  <a href="https://github.com/superstrellaa/StorageManager-API/releases">
+    <img src="https://img.shields.io/github/v/release/superstrellaa/StorageManagerAPI?style=flat-square" />
+  </a>
+  <img src="https://img.shields.io/badge/Minecraft-1.21-blue?style=flat-square" />
+  <img src="https://img.shields.io/badge/Loader-Fabric-blueviolet?style=flat-square" />
+  <a href="https://github.com/superstrellaa/StorageManager-API/issues">
+    <img src="https://img.shields.io/github/issues/superstrellaa/StorageManager-API?style=flat-square" />
+  </a>
+  <img src="https://img.shields.io/github/license/superstrellaa/StorageManager-API?style=flat-square" />
+</p>
+
+The **StorageManager API** provides an easy way to manage persistent storage for your mods. It allows you to create, read, update, and delete structured data in an efficient, server-friendly way. By default, it uses **SQLite** as the storage backend with write-behind caching for high performance.
+
+---
 
 ## Features
-- Create, read, update, and delete data in various storage systems.
-- Using SQLite as the default storage backend.
-- Easy-to-use interface for managing storage operations in your own mod.
 
-//TODO
+- Create, read, update, and delete data in your mods.
+- Async write caching to improve performance.
+- Built-in support for global and player-specific data.
+- Easy-to-use API with minimal boilerplate.
+
+---
+
+## Important Notes
+
+- Do **not** touch the `.internal` package. It is meant for internal use only. It also contains tags ApiStatus.Internal.
+- The API is **server-side only**:
+    - On client-side, the API does nothing and will only produce warnings if used.
+    - Always call storage operations after the server has started.
+- There is no Maven repository for this mod yet. You must manually include the JAR in your project.
+
+---
+
+## Installation
+
+1. Download the **StorageManager API** JAR.
+2. In your mod project (where you have `build.gradle` and `gradle.properties`), create a folder called `lib`.
+3. Place the JAR inside the `lib` folder.
+4. Add the following to your `build.gradle`:
+
+``` gradle
+repositories {
+	flatDir {
+		dirs 'lib'
+	}
+}
+
+dependencies {
+    modImplementation(name: "storagemanager-api-1.0.0+1.21.1")
+}
+```
+
+5. Rebuild your project. The API is now ready to use.
+
+---
+
+## 📝 Usage Examples
+
+### Registering Tables
+
+``` java
+StorageManager.registerTable(
+    TableSchema.builder("global_data")
+        .column("key", ColumnType.TEXT, true)
+        .column("value", ColumnType.INTEGER)
+        .primaryKey("key")
+        .build()
+);
+
+StorageManager.registerTable(
+    TableSchema.builder("player_data")
+        .column("uuid", ColumnType.TEXT, true)
+        .column("key", ColumnType.TEXT, true)
+        .column("value", ColumnType.INTEGER)
+        .primaryKey("uuid", "key")
+        .build()
+);
+```
+
+### Inserting Data
+
+``` java
+StorageManager.insert("global_data", new RowData()
+    .set("key", "time")
+    .set("value", 100)
+);
+
+StorageManager.insert("player_data", new RowData()
+    .set("uuid", player.getUuidAsString())
+    .set("key", "points")
+    .set("value", 50)
+);
+```
+
+### Reading Data
+
+``` java
+var rows = StorageManager.select("player_data", Map.of(
+    "uuid", player.getUuidAsString(),
+    "key", "points"
+));
+
+for (var row : rows) {
+    int points = (Integer) row.values().get("value");
+}
+```
+
+### Updating / Deleting Data
+
+``` java
+StorageManager.delete("global_data", Map.of("key", "time"));
+
+StorageManager.insertImmediate("player_data", new RowData()
+    .set("uuid", player.getUuidAsString())
+    .set("key", "points")
+    .set("value", 75)
+);
+```
+
+### Flush Cache
+
+``` java
+StorageManager.flushAll();
+```

src/main/java/es/superstrellaa/storagemanager/internal/bootstrap/ServerBootstrap.java

@@ -5,7 +5,9 @@
 import es.superstrellaa.storagemanager.internal.cache.WriteCache;
 import es.superstrellaa.storagemanager.internal.lifecycle.ShutdownHook;
 import es.superstrellaa.storagemanager.internal.middleware.ServerGuard;
+import org.jetbrains.annotations.ApiStatus;
 
+@ApiStatus.Internal
 public final class ServerBootstrap {
 
     private static boolean initialized = false;

src/main/resources/assets/storagemanager-api/icon.png

@@ -3,7 +3,7 @@
 	"id": "storagemanager-api",
 	"version": "${version}",
 	"name": "StorageManager API",
-	"description": "An API for manage storage systems in Minecraft backends.",
+	"description": "An API for manage storage systems in Minecraft backends",
 	"authors": [
 		"superstrellaa"
 	],
@@ -32,7 +32,7 @@
 				"modmenu.donate" : "https://paypal.me/superstrella",
 				"modmenu.github_releases" : "https://github.com/superstrellaa/StorageManager-API/releases",
 				"modmenu.modrinth" : "https://modrinth.com/mod/StorageManager-API",
-				"modmenu.curseforge" : "https://www.curseforge.com/minecraft/mc-mods/storage-manager-api"
+				"modmenu.curseforge" : "https://www.curseforge.com/minecraft/mc-mods/storagemanager-api"
 			}
 		}
 	}