From e419882691444b88484aa623c46c3df669de6bc7 Mon Sep 17 00:00:00 2001
From: Michael Aaron Murphy <mmstick@pm.me>
Date: Wed, 22 Sep 2021 23:08:52 +0200
Subject: [PATCH] chore(readme): Document `plugin.ron` file

Closes #23
---
 README.md | 32 +++++++++++++++++++++++++++++---
 1 file changed, 29 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 3fe5b42..e2686af 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,35 @@ Using IPC enables each plugin to isolate their data from other plugin processes
 
 ## Plugin Directories
 
-- User-local plugins: `~/.local/share/pop-launcher/plugins`
-- System-wide install for system administrators: `/etc/pop-launcher/plugins`
-- Distribution packaging: `/usr/lib/pop-launcher/plugins`
+- User-local plugins: `~/.local/share/pop-launcher/plugins/{plugin}/`
+- System-wide install for system administrators: `/etc/pop-launcher/plugins/{plugin}/`
+- Distribution packaging: `/usr/lib/pop-launcher/plugins/{plugin}/`
+
+## Plugin Config
+
+A plugin's metadata is defined `pop-launcher/plugins/{plugin}/plugin.ron`.
+
+```ron
+(
+    name: "PluginName",
+    description: "Plugin Description: Example",
+    bin: (
+        path: "name-of-executable-in-plugin-folder",
+    )
+    icon: Name("icon-name-or-path"),
+    // Optional
+    query: (
+        // Optional -- if we should isolate this plugin when the regex matches
+        isolate: true,
+        // Optional -- Plugin which searches on empty queries
+        persistent: true,
+        // Optional -- avoid sorting results from this plugin
+        no_sort: true,
+        // Optional -- pattern that a query must have to be sent to plugin
+        regex: "pattern"
+    )
+)
+```
 
 ## Script Directories