From e73593371f3353ecf46883d535fc391cd8a4a023 Mon Sep 17 00:00:00 2001
From: leafspark <78000825+leafspark@users.noreply.github.com>
Date: Thu, 22 Aug 2024 20:10:22 -0700
Subject: [PATCH] Created Plugins (markdown)

---
 Plugins.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 Plugins.md

diff --git a/Plugins.md b/Plugins.md
new file mode 100644
index 0000000..9d00dfd
--- /dev/null
+++ b/Plugins.md
@@ -0,0 +1,29 @@
+The AutoGGUF plugin system allows users to extend and customize the functionality of the AutoGGUF application. Plugins can add new features, modify existing behaviors, and integrate with the core application.
+
+## Plugin Structure
+
+A plugin is a Python file placed in the `plugins` directory. Each plugin should contain a main class that defines the plugin's functionality.
+
+### Basic Plugin Template
+
+```python
+class MyPlugin:
+    def init(self, autogguf_instance):
+        # This method is called after the plugin is loaded
+        # You can use it to set up your plugin or modify the AutoGGUF instance
+        pass
+
+    def __data__(self):
+        # This method should return metadata about your plugin
+        return {
+            "name": "My Plugin",
+            "description": "This is an example plugin.",
+            "supported_versions": ["*"],
+            "author": "Your Name",
+            "version": "1.0.0"
+        }
+
+    # Add your custom methods and attributes here
+    # These replace the ones in the AutoGGUF class if the name matches
+    def my_custom_method(self):
+        print("This is a custom method from the plugin")