Merge remote-tracking branch 'origin/master'

Author: RaydanOMGr

README.md

@@ -1,6 +1,104 @@
 # BasicModInfoParser
-A basic parser for minecraft mod info.
-Currently supports:
-- Legacy Forge (mcmod.info)
-- Forge and NeoForge (mods.toml and neoforge.mods.toml)
-- Fabric (fabric.mod.json)
+
+[![](https://jitpack.io/v/RaydanOMGr/BasicModInfoParser.svg)](https://jitpack.io/#RaydanOMGr/BasicModInfoParser)
+
+BasicModInfoParser is a lightweight Java library that helps you extract basic information from mod files (such as `.jar` files) for platforms like Minecraft Forge or Fabric. The library parses data such as mod ID, name, version, and description, making it easier to handle mod metadata programmatically.
+
+## Features
+- Supports detecting mod platforms (Forge, Fabric, etc.).
+- Parses mod metadata, including:
+  - Mod ID
+  - Mod Name
+  - Version
+  - Description
+
+## Installation
+
+To include this library in your project using JitPack, follow these steps:
+
+1. Add the JitPack repository to your project's `build.gradle` file (or equivalent for other build systems).
+
+### Gradle
+
+```groovy
+repositories {
+    maven { url 'https://jitpack.io' }
+}
+
+dependencies {
+    implementation 'com.github.RaydanOMGr:BasicModInfoParser:1.0.1'
+}
+```
+
+### Maven
+
+```xml
+<repositories>
+    <repository>
+        <id>jitpack.io</id>
+        <url>https://jitpack.io</url>
+    </repository>
+</repositories>
+
+<dependency>
+    <groupId>com.github.RaydanOMGr</groupId>
+    <artifactId>BasicModInfoParser</artifactId>
+    <version>1.0.1</version>
+</dependency>
+```
+
+## Usage
+
+Here's a simple example demonstrating how to use `BasicModInfoParser` to extract mod information from `.jar` files:
+
+```java
+import me.andreasmelone.basicmodinfoparser.Platform;
+import me.andreasmelone.basicmodinfoparser.BasicModInfo;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.jar.JarFile;
+
+public class ModInfoExample {
+    public static void main(String[] args) {
+        // Specify the folder containing your .jar files
+        File folder = new File("mods/");
+        File[] modFiles = folder.listFiles((dir, name) -> name.endsWith(".jar"));
+
+        if (modFiles != null) {
+            for (File modFile : modFiles) {
+                try (JarFile jarFile = new JarFile(modFile)) {
+                    // Detect the mod platform (Forge, Fabric, etc.)
+                    Platform[] platforms = Platform.findModPlatform(modFile);
+                    for (Platform platform : platforms) {
+                        // Get the mod info content and parse it
+                        String modInfoContent = platform.getInfoFileContent(jarFile);
+                        BasicModInfo modInfo = platform.parse(modInfoContent);
+                        
+                        // Output the parsed mod information
+                        System.out.println("Mod ID: " + modInfo.getId());
+                        System.out.println("Mod Name: " + modInfo.getName());
+                        System.out.println("Mod Version: " + modInfo.getVersion());
+                        System.out.println("Mod Description: " + modInfo.getDescription());
+                    }
+                } catch (IOException e) {
+                    System.err.println("Failed to read mod file: " + modFile.getName());
+                    e.printStackTrace();
+                }
+            }
+        }
+    }
+}
+```
+
+### BasicModInfo Object
+
+The `BasicModInfo` object stores the following details about a mod:
+- **id**: The unique identifier for the mod.
+- **name**: The name of the mod.
+- **version**: The version of the mod.
+- **description**: A brief description of the mod.
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for more details.