Add examples for submitting and updating plugins

README.md

@@ -29,6 +29,7 @@ A plugin manager for the game - [Bombsquad](https://www.froemling.net/apps/bombs
 ## Contributing
 
 ### Submitting a Plugin
+
 - In order for a plugin to get accepted to this official repository, it must target the general game audience and be
   completely open and readable, not be encoded or encrypted in any form.
 - If your plugin doesn't target the general game audience, you can put your plugins in a GitHub repository and then
@@ -36,17 +37,115 @@ A plugin manager for the game - [Bombsquad](https://www.froemling.net/apps/bombs
   See [3rd party plugin sources](#3rd-party-plugin-sources) for more information.
 - New plugins are accepted through a [pull request](../../compare). Add your plugin in the minigames, utilities, or
   the category directory you feel is the most relevant to the type of plugin you're submitting, [here](plugins).
-  Then add an entry to the category's JSON metadata file (check out existing entries to know what all fields are required).
-  Plugin manager will also show and execute the settings icon if your `ba.Plugin` export class has a method named
+  Then add an entry to the category's JSON metadata file.
+- Plugin manager will also show and execute the settings icon if your `ba.Plugin` export class has a method named
   `on_plugin_manager_prompt`; check out the
   [colorscheme](https://github.com/bombsquad-community/plugin-manager/blob/f24f0ca5ded427f6041795021f1af2e6a08b6ce9/plugins/utilities/colorscheme.py#L419-L420)
   plugin for an example and it's behaviour when the settings icon is tapped on via the plugin manager in-game.
 
+#### Example:
+
+Let's say you wanna submit this new utility-type plugin named as `sample_plugin.py`:
+```python
+# ba_meta require api 7
+import ba
+
+# ba_meta export plugin
+class Main(ba.Plugin):
+    def on_app_running(self):
+        ba.screenmessage("Hi! I am a sample plugin!")
+
+    def on_plugin_manager_prompt(self):
+        ba.screenmessage("You tapped my settings from the Plugin Manager Window!")
+```
+
+You'll have to fork this repository and add your `sample_plugin.py` plugin file into the appropriate directory, which for
+utility plugins is [plugins/utilities](plugins/utilities). Now you'll have to add an entry for your plugin
+in [plugins/utilities.json](plugins/utilities.json) so that it gets picked up by the Plugin Manager in-game.
+
+To do this, you'll have to edit the file and add something like this:
+```json
+{
+  "name": "Utilities",
+  ...
+  "plugins": {
+    ...
+    "sample_plugin": {
+      "description": "Shows screenmessages!",
+      "external_url": "",
+      "authors": [
+        {
+          "name": "Alex",
+          "email": "alex@example.com",
+          "discord": null
+        }
+      ],
+      "versions": {
+        "1.0.0": null
+      }
+    },
+    ...
+  }
+  ...
+}
+```
+You can add whatever you wanna add to these fields. However, leave the value for your version key `null`:
+```json
+"1.0.0": null
+```
+Version values will automatically be populated through github-actions (along with formatting your code as per PEP8 style
+guide) once you open a pull request.
+
+Save `utilities.json` with your modified changes and now you can make us a [pull request](../../compare) with the
+plugin you've added and the modified JSON metadata file!
+
 ### Updating a Plugin
+
 - Make a [pull request](../../compare) with whatever changes you'd like to make to an existing plugin, and add a new
   version entry in your plugin category's JSON metadata file.
 
+#### Example
+
+Continuing the example from [Submitting a Plugin](#submitting-a-plugin) section, say you also wanna add a new screenmessage
+to the `sample.py` plugin after it was submitted. Edit `sample.py` with whatever changes you'd like:
+```diff
+diff --git a/bla.py b/bla.py
+index ebb7dcc..da2b312 100644
+--- a/plugins/utilities/sample.py
++++ b/plugins/utilities/sample.py
+@@ -5,6 +5,7 @@ import ba
+ class Main(ba.Plugin):
+     def on_app_running(self):
+         ba.screenmessage("Hi! I am a sample plugin!")
++        ba.screenmessage("Hey! This is my new screenmessage!")
+ 
+     def on_plugin_manager_prompt(self):
+         ba.screenmessage("You tapped my settings from the Plugin Manager Window!")
+```
+
+To name this new version as `1.1.0`, add `"1.1.0": null,` just above the previous plugin version in `utilities.json`:
+```diff
+diff --git a/bla.json b/bla.json
+index d3fd5bc..34ce9ad 100644
+--- a/plugins/utilities.json
++++ b/plugins/utilities.json
+@@ -14,7 +14,10 @@
+         }
+       ],
+       "versions": {
+-        "1.0.0": null
++        "1.1.0": null,
++        "1.0.0": {
++          ...
++        }
+       }
+     },
+     ...
+```
+That's it! Now you can make a [pull request](../../compare) with both the updated `sample.py` and `utilities.json` files.
+
 ## 3rd Party Plugin Sources
+
 - In case your plugin doesn't sit well with our guidelines or you wouldn't want your plugin to be here for some reason,
   you can create your own GitHub repository and put all your plugins in there.
 - Check out https://github.com/rikkolovescats/sahilp-plugins for an example. You can choose to show up plugins from this