Update structures and project documentation

.github/workflows/maven-package.yml

@@ -1,4 +1,4 @@
-name: Publish package to GitHub Packages
+name: SingularityLib Build and Publish
 on:
   push:
     branches:

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Nont Nonnipat
+Copyright (c) 2025 Nonnipat Tangrojjanakhajorn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,14 @@
 # SingularityLib
-[![wakatime](https://wakatime.com/badge/user/fa854c4c-5b98-4588-9b55-1dcd1509c1b5/project/d1822b62-d256-42bf-bc4e-ad773ce009dc.svg)](https://wakatime.com/badge/user/fa854c4c-5b98-4588-9b55-1dcd1509c1b5/project/d1822b62-d256-42bf-bc4e-ad773ce009dc) [![Maven Package](https://github.com/Pinont/SingularityLib/actions/workflows/maven-package.yml/badge.svg)](https://github.com/Pinont/SingularityLib/actions/workflows/maven-package.yml)
 
-A Minecraft plugin api that provides a lot of benefit to develop Minecraft plugin much easier 
+A fork of [ExperienceLib](https://github.com/pinont/ExperienceLib)
+
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/pinont/singularitylib/maven-package.yml)
+](https://github.com/Pinont/SingularityLib/actions/workflows/maven-package.yml) ![GitHub Tag](https://img.shields.io/github/v/tag/pinont/singularitylib)
+[![license](https://img.shields.io/github/license/pinont/singularitylib)](https://github.com/Pinont/SingularityLib/blob/main/LICENSE) 
+
+---
+
+A Minecraft plugin api that provides a lot of benefit to develop Minecraft plugin much easier
 
 ## Features
 
@@ -11,17 +18,44 @@ A Minecraft plugin api that provides a lot of benefit to develop Minecraft plugi
 - Better Item Configuration, item interaction, item locking and unique item management
 - Better Entity Configuration and Storing
 - Auto Register for cleaner code and management
+- Database support (MYSQL)
+- Discord JDA Boostrap (SlashCommands)
 
-Add our library Via [Jitpack](https://jitpack.io/#Pinont/SingularityLib)
-
-### Q&A
+## Future Plans
+- [ ] More GUI features (Paginated GUI, Animated GUI)
+- [ ] More Item features (Item Enchantments, Item Attributes)
+- [ ] More Entity features (Custom Entities, Entity Attributes)
+- [ ] More Command features (SubCommands, Command Aliases)
+- [ ] Custom Crafting Recipes
+- [ ] Discord JDA support (TextCommands, Listeners)
+- [ ] More database support (SQLite, MongoDB)
 
+## Installation
+On your `pom.xml`, add the following dependency:
+```xml
+<dependency>
+  <groupId>com.pinont</groupId>
+  <artifactId>singularitylib</artifactId>
+  <version>2.1.3</version>
+</dependency>
 ```
-Q: Why was SingularityLib built so fast?
 
-A: SingularityLib is a fork of ExperienceLib. It was developed with passion,
-and the three years spent building the Minecraft plugin ExperienceLib provided a strong foundation.
-Every time I discovered a new way to develop mechanics for Minecraft plugins,
-it contributed to the knowledge base. So, when SingularityLib was built,
-it already had a significant head start from the old project.
+## Usage
+To use SingularityLib, your main class must extend `CorePlugin` instead of `JavaPlugin`.
+```java
+public class Main extends CorePlugin {
+    @Override
+    public void onPluginStart() {
+        // plugin start logic goes here
+    }
+    @Override
+    public void onPluginStop() {
+        // plugin stop logic goes here
+    }
+}
 ```
+
+---
+
+> ## ⚠️ Disclaimer 
+> This project is still in development, so expect some bugs and missing features. If you find any bugs or have any feature requests, please open an issue on the [GitHub repository](https://github.com/Pinont/SingularityLib/issues)

pom.xml

@@ -5,8 +5,8 @@
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>com.pinont</groupId>
-    <artifactId>singularitylib</artifactId>
-    <version>2.1.4</version>
+    <artifactId>SingularityLib</artifactId>
+    <version>2.2.0</version>
     <packaging>jar</packaging>
 
     <name>SingularityLib</name>