docs: create README.md

README.md

@@ -0,0 +1,102 @@
+# MCExtension API
+
+MCExtension is a flexible, lightweight framework designed to allow Minecraft plugins to load external JARs as "Extensions." It features built-in dependency resolution for both Bukkit plugins and other extensions.
+
+---
+
+## 📦 Installation
+
+To use MCExtension in your project, add the following to your `pom.xml`. Note that you must configure your GitHub credentials in your `settings.xml` to access the repository.
+
+```xml
+<dependency>
+  <groupId>io.github.mcengine</groupId>
+  <artifactId>mcextension</artifactId>
+  <version>{yyyy.{m}.{m} or {yyyy.{m}.{m}-{iteration}</version> 
+</dependency>
+```
+
+## 🛠️ Key Components
+
+`IMCExtension` **(Interface)**
+
+The core interface defining the identity and lifecycle of an extension.
+
+**Methods:**
+
+- `onLoad(JavaPlugin plugin, Executor executor)`: Triggered when the extension is loaded. Use this to register listeners or initialize logic.
+
+- `onDisable(JavaPlugin plugin, Executor executor)`: Triggered when the extension is disabled. Use this to clean up resources.
+
+- `checkUpdate(String url, String token)`: Optional method to implement custom update checks. Returns `false` by default.
+
+## 🚀 Usage Examples
+
+**1. Creating an Extension**
+
+Implement the `IMCExtension` interface in your extension project.
+
+```java
+package io.github.example;
+
+import io.github.mcengine.mcextension.api.IMCExtension;
+import org.bukkit.plugin.java.JavaPlugin;
+import java.util.concurrent.Executor;
+
+public class MyExtension implements IMCExtension {
+
+    @Override
+    public void onLoad(JavaPlugin plugin, Executor executor) {
+        plugin.getLogger().info("MyExtension has been loaded!");
+    }
+
+    @Override
+    public void onDisable(JavaPlugin plugin, Executor executor) {
+        plugin.getLogger().info("MyExtension is shutting down.");
+    }
+}
+```
+
+**2. Managing Extensions**
+
+Use the `MCExtensionManager` in your main plugin to handle the loading process.
+
+```java
+public class MyMainPlugin extends JavaPlugin {
+    private MCExtensionManager manager;
+
+    @Override
+    public void onEnable() {
+        // Initialize manager with a task executor
+        this.manager = new MCExtensionManager(this, Runnable::run);
+
+        // Loads all .jar files from /plugins/MyMainPlugin/extensions/
+        this.manager.loadAllExtensions();
+    }
+
+    @Override
+    public void onDisable() {
+        this.manager.disableAllExtensions();
+    }
+}
+```
+
+## 📄 Extension Metadata (`extension.yml`)
+
+Place this file in `src/main/resources` of your extension project to define its dependencies and main class.
+
+```yaml
+name: "MyExtension"
+main: "io.github.mcengine.MyExtension"
+version: "1.0.0"
+base:
+  depend: [Vault] # Bukkit plugins required
+  softdepend: [Essentials]
+extension:
+  depend: [OtherExtID] # Other extensions required
+  softdepend: [exampleExt]
+```
+
+## 🔗 Resources
+
+- **Example Project:** [Example Extension](https://github.com/MCEngine/extension)