Merge pull request #1 from germanocaumo/first-version-wip

First working version

README.md

@@ -1,13 +1,40 @@
-# Repository of a plugin for BigBlueButton
+# Media Popout Plugin
 
 ## Description
 
-A brief description of the plugin including a screenshot or a short video.
+This plugins adds a button in the top right corner of Webcams and Screenshare to allow the video stream to be opened in a new window.
+
+![Gif of plugin demo](./public/assets/plugin.gif)
 
 ## Running the Plugin From Source Code
 
+1. Start the development server:
+
+```bash
+npm install
+npm start
+```
+
+2. Add this to the `settings.yml` of the BBB HTML5-client:
+```yaml
+public:
+  plugins:
+    - name: MediaPopoutPlugin
+      url: <<PLUGIN_URL>>
+```
+
 ## Building the Plugin
 
+To build the plugin for production use, follow these steps:
+
+```bash
+npm install
+npm run build-bundle
+```
+
+The above command will generate the `dist` folder, containing the bundled JavaScript file named `MediaPopoutPlugin.js`. This file can be hosted on any HTTPS server.
+
+Alternatively, you can host the bundled file on the BigBlueButton server by copying dist/TourPlugin.js to the folder /var/www/bigbluebutton-default/assets/plugins. In this case, the <<PLUGIN_URL>> will be https://<your-host>/plugins/MediaPopoutPlugin.js.
 
 ## Background
 

locales/en.json

@@ -0,0 +1,3 @@
+{
+  "app.popoutButton.label": "Popout video to new window"
+}

locales/pt-BR.json

@@ -0,0 +1,3 @@
+{
+  "app.popoutButton.label": "Abrir em nova janela"
+}