Add README and update project metadata

Author: Hotkeyyy

README.md

@@ -0,0 +1,61 @@
+# SimpleFabricScoreboard
+A lightweight Kotlin module for Minecraft Fabric providing a simple and flexible API for managing scoreboard sideboards.
+
+## Features
+- Easy creation and management of scoreboard sideboards.
+- Support for dynamic content updates.
+- Packet based.
+- Integration with Minecraft's native scoreboard system.
+- Lightweight and efficient.
+- Designed for Fabric modding environment.
+- Kotlin-based for modern development practices.
+- Good documentation and examples.
+- Active maintenance and updates.
+- Compatible with the latest Minecraft versions.
+- Modular design for easy integration into existing projects.
+- Support for multiple sideboards simultaneously.
+- User-friendly API for developers of all skill levels.
+
+## Installation
+To use SimpleFabricScoreboard in your Fabric mod, add the following dependency to your `build.gradle.kts` file:
+```kotlin
+//build.gradle.kts
+dependencies {
+    modImplementation("de.hotkeyyy:simplefabricscoreboard:1.0.3")
+}
+```
+
+## Usage (Kotlin Example)
+
+register a sideboard and set its content:
+```kotlin
+val board = ScoreboardManager.createScoreboard(
+                "Test Board", 
+                server,
+                Text.of("Line 1"),
+                Text.of("Line 2"),
+                Text.of("Line 3"),
+                Text.of("Line 4"),
+                )
+            
+ScoreboardManager.setPlayerScoreboard(player, board)
+```
+
+update content dynamically:
+```kotlin
+board.updateLine(3, Text.of("Updated Line 3"))
+```
+remove the sideboard from a player:
+```kotlin
+ScoreboardManager.removePlayerScoreboard(player)
+```
+remove all sideboards:
+```kotlin
+ScoreboardManager.clearAllBoards()
+```
+
+## Contributing
+Issues and pull requests are welcome! Feel free to contribute to the project by submitting bug reports, feature requests, or code contributions.
+
+
+

build.gradle.kts

@@ -106,8 +106,9 @@ configure<PublishingExtension> {
 
         register<MavenPublication>("maven") {
             from(components["java"])
+            artifactId = "${project.property("archives_base_name")}"
             pom {
-                name.set(project.name)
+                name.set(project.name.lowercase())
                 description.set(project.description ?: project.name)
                 url.set("https://github.com/hotkeyyy/simplefabricscoreboard")
                 licenses {
@@ -141,6 +142,7 @@ configure<PublishingExtension> {
 // JReleaser Konfiguration
 jreleaser {
     project {
+        name = "simplefabricscoreboard"
         description = "A lightweight Kotlin module for Minecraft Fabric providing a simple and flexible API for managing scoreboards."
         authors = listOf("Hotkeyyy")
         license = "Apache-2.0"

gradle.properties

@@ -7,7 +7,7 @@ yarn_mappings=1.21.5+build.1
 loader_version=0.17.3
 kotlin_loader_version=1.13.6+kotlin.2.2.20
 # Mod Properties
-mod_version=1.0.3
+mod_version=1.0.4
 maven_group=de.hotkeyyy
 archives_base_name=simplefabricscoreboard
 # Dependencies

src/main/kotlin/de/hotkeyyy/simplefabricscoreboard/scoreboard/ScoreboardManager.kt

@@ -34,8 +34,8 @@ object ScoreboardManager {
     fun createScoreboard(
         name: String,
         displayName: Text,
-        vararg lines: Text,
-        server: net.minecraft.server.MinecraftServer
+        server: net.minecraft.server.MinecraftServer,
+        vararg lines: Text
     ): Simplescoreboard {
         val board = Simplescoreboard(name, displayName, server)
         board.setLines(*lines)