ref: Update template to use the new plugin manifest structure (#10)

* [manifest-structure] - added manifest structure to template

* Update README.md

Co-authored-by: Anton Georgiev <[email protected]>

---------

Co-authored-by: Anton Georgiev <[email protected]>

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 dist
+dist-tsc
 debian/.debhelper/
 debian/debhelper-build-stamp
 debian/files

README.md

@@ -2,16 +2,31 @@
 
 ## Description
 
-A brief description of the plugin including a screenshot or a short video.
-
-## Running the Plugin From Source Code
+A brief description of the plugin including a screenshot and/or a short video.
 
 ## Building the Plugin
 
+To build the plugin for production use, follow these steps:
+
+```bash
+cd $HOME/src/plugin-template
+npm ci
+npm run build-bundle
+```
+
+The above command will generate the `dist` folder, containing the bundled JavaScript file named `<plugin-name>.js`. This file can be hosted on any HTTPS server along with its `manifest.json`.
+
+If you install the Plugin separated to the manifest, remember to change the `javascriptEntrypointUrl` in the `manifest.json` to the correct endpoint.
+
+To use the plugin in BigBlueButton, send this parameter along in create call:
+
+```
+pluginManifests=[{"url":"<your-domain>/path/to/manifest.json"}]
+```
+
+Or additionally, you can add this same configuration in the `.properties` file from `bbb-web` in `/usr/share/bbb-web/WEB-INF/classes/bigbluebutton.properties`
 
-## Background
 
-BigBlueButton added supports for plugins in 2024 with BBB 3.0.
-Check the official [documentation website](https://docs.bigbluebutton.org) for more information.
+## Development mode
 
-This plugin repository was created using the plugin [template repository for BigBlueButton](https://github.com/bigbluebutton/plugin-template) hosted on GitHub.
+As for development mode (running this plugin from source), please, refer back to https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk section `Running the Plugin from Source`

manifest.json

@@ -0,0 +1,29 @@
+{
+  "requiredSdkVersion": "~0.0.59",
+  "name": "<plugin-name>",
+  "javascriptEntrypointUrl": "<plugin-name>.js",
+  "localesBaseUrl": "https://cdn.dominio.com/pluginabc/",
+  "eventPersistence": {
+      "isEnabled": true,
+      "maximumPayloadSizeInBytes": 1024,
+      "rateLimiting": {
+          "messagesAllowedPerSecond": 10,
+          "messagesAllowedPerMinute": 20
+      }
+  },
+  "dataChannels": [
+      {
+          "name": "<data-channel-name>",
+          "pushPermission": ["moderator"],
+          "replaceOrDeletePermission": ["creator", "moderator"]
+      }
+  ],
+  "remoteDataSources": [
+      {
+          "name": "<remote-data-source-name>",
+          "url": "${meta_remote-data-uri}",
+          "fetchMode": "onMeetingCreate",
+          "permissions": ["moderator"]
+      }
+  ]
+}