From 553cff8075eeb58aacd00d2dbac98d64ee53b674 Mon Sep 17 00:00:00 2001
From: imgurbot12 <imgurbot12@gmail.com>
Date: Sun, 20 Aug 2023 19:45:20 -0700
Subject: [PATCH] feat: better plugin/scripting explanations

---
 README.md | 39 +++++++++++++++++++++++++++++++++++----
 1 file changed, 35 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 886d4c5..75b9a43 100644
--- a/README.md
+++ b/README.md
@@ -25,17 +25,35 @@ $ make install
 
 ### Usage
 
-RMenu Comes with Two Builtin Plugins: "Desktop Run" aka `drun`. 
+View all available options with the builtin help:
+
+```bash
+$ rmenu --help
+```
+
+RMenu Comes with a few default plugins.
+
+| Name      | Description                                             |
+| :-------: | ------------------------------------------------------- |
+| run       | Execute a program in $PATH                              |
+| drun      | Run a Configured Free-Desktop Application               |
+| audio     | Select and Set-Default PulseAudio Sink using `pactl`    |
+| network   | Wi-Fi Login/Connection Tool using Network-Manager       |
+| window    | Simple Window Switcher (Currently Only Support Sway)    |
+| powermenu | Simple Power/Logout Tool (Currently Only Supports Sway) |
+
+Run a plugin by passing the `-r` flag like one of the following:
 
 ```bash
 $ rmenu -r run
+$ rmenu -r drun
+$ rmenu -r audio
 ```
 
-RMenu also comes with a "$PATH Run" plugin aka `run`. 
-Both are managed via the default configuration file after installation.
+Or even run plugins in combination if you'd like:
 
 ```bash
-$ rmenu -r drun
+$ rmenu -r run -r drun
 ```
 
 Custom Menus can also be passed much like Dmenu by passing items via
@@ -61,6 +79,19 @@ Customize the entire app's appearance with CSS. A few [Example Themes](./themes/
 are available as reference. To try them out use: `rmenu --css <my-css-theme>`
 or move the css file to `$HOME/.config/rmenu/style.css`
 
+### Scripting
+
+RMenu plugins and imports communicate using JSON messages defined in `rmenu-plugin`.
+Writing JSON in shell is painful, so rmenu provides another cli-tool to help build
+messages quickly and easily while still retaining the flexibility of JSON.
+
+After Installing. Use the following command, and look at [other-plugins](./other-plugins)
+for example uses.
+
+```
+$ rmenu-build --help
+```
+
 ### Example Screenshots
 
 #### Launchpad