瀏覽代碼

update documentation for olmeet and voicechat plugins

Dele Olajide 2 月之前
父節點
當前提交
37cfb65d22
共有 4 個文件被更改,包括 46 次插入2 次删除
  1. 二進制
      packages/olmeet/olmeet.png
  2. 17 0
      packages/olmeet/package.json
  3. 26 0
      packages/olmeet/readme.md
  4. 3 2
      packages/voicechat/readme.md

二進制
packages/olmeet/olmeet.png


+ 17 - 0
packages/olmeet/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@converse-plugins/olmeet",
+  "author": "Dele Olajide",
+  "license": "Apache 2.0",
+  "version": "0.0.1-alpha.0",
+  "keywords": [
+    "converse.js",
+    "plugin"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/conversejs/community-plugins.git"
+  }
+}

+ 26 - 0
packages/olmeet/readme.md

@@ -0,0 +1,26 @@
+# Jitsi Meet plugin for converse.js
+
+<img src="https://github.com/conversejs/community-plugins/blob/master/packages/olmeet/olmeet.png?raw=true" />
+
+## Overview
+This plugin uses any hosted video conferencing service like Jitsi, Galene, etc to deliver an online meeting (audio/video conferencing) user experience.
+
+## Install
+see https://m.conversejs.org/docs/html/plugin_development.html on how to install this plugin
+
+## Configure
+To configure, edit the converse settings and modify all the jitsimeet_  values. See index.html for an example
+
+```
+converse.initialize({
+    ....
+    olmeet_modal: false,
+    olmeet_url: 'https://meet.jit.si',
+    ....
+});
+```
+
+Default setting will use the public meet.ji.si service.
+
+## How to use
+Click on the video icon on the conversation toolbar to turn a chat or groupchat into an audio/video conference

+ 3 - 2
packages/voicechat/readme.md

@@ -3,10 +3,11 @@
 <img src="https://github.com/conversejs/community-plugins/blob/master/packages/voicechat/voicechat.png" />
 
 ## Overview
-This plugin enables you to have a voice chat. It uses the morning.fm web client hosted on talk.4ng.net (deleolajide.github.io/morning.fm) which in turn connects to a kraken SFU at rpc.kraken.fm.
+This plugin enables you to have a voice chat using WHIP and WHEP. It uses the morning.fm web client hosted on talk.4ng.net (deleolajide.github.io/morning.fm) which in turn connects to an Openfire XMPP server running a WHIP/WHEP service at https://pade.chat:5443
+The plugin is currently accessing the media streams directly with HTTP. I plan to modify it later to use XMPP using this media streams XEP  - https://igniterealtime.github.io/openfire-orinayo-plugin/xep/
 
 ## Install
 see https://m.conversejs.org/docs/html/plugin_development.html on how to install this plugin. Please note that the plugin has a dependency on rpc.kraken.fm and github.io.
 
 ## How to use
-Click on disk icon on the conversation toolbar to display the modal form
+Click on disk icon on the conversation toolbar to display the modal form and join the conversation and see other participants.