From afe01f72965040810e3da1a12bb627f7f12937c4 Mon Sep 17 00:00:00 2001
From: timetheoretical <56090670+timetheoretical@users.noreply.github.com>
Date: Sun, 10 May 2020 21:59:48 +0200
Subject: [PATCH] Update README.md
Readme updated to reflect new installation features in v0.4.0.
---
README.md | 23 +++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 0f7b480..e14d07a 100644
--- a/README.md
+++ b/README.md
@@ -18,25 +18,40 @@ The screenshots below display the features of implemented in this add-in.
### Settings
+### CMD Install
+
## Installation
### New
-Go to the [releases](/../../releases) page and download the MSI installer for the latest version. Make sure to download and run the JitsiMeetOutlook-v-windows-.msi file that matches the architecture of your installation of Microsoft Office. I.e. if Office was installed as 64-bit, then run JitsiMeetOutlook-v0.3.0-windows-x64.msi.
+Go to the [releases](/../../releases) page and download the MSI installer for the latest version. Make sure to download and run the JitsiMeetOutlook-v-windows-.msi file that matches the architecture of your installation of Microsoft Office. I.e. if Office was installed as 64-bit, then run JitsiMeetOutlook-v0.4.0-windows-x64.msi.
### Upgrade
-Please uninstall any previously installed version of this add-in via the "Add or remove programs" pane in Windows before updating.
+Please uninstall any previously installed version of this add-in via the "Add or remove programs" pane in Windows before upgrading.
### Uninstall
-The add-in can be uninstalled via the "Add or remove programs" pane in Windows, or by running the setup_.msi file again.
+The add-in can be uninstalled via the "Add or remove programs" pane in Windows, or by running the JitsiMeetOutlook-v-windows-.msi file again.
+
+### Command Line
+As of v0.4.0, the add-in can be installed via command line with custom setting passed as parameters. This works by calling `msiexec` on the .msi installer file. The following parameters can be passed to the installer to preconfigure the Jitsi Meet Outlook add-in settings (all are optional):
+* `TARGETDIR`: Path to the install directory.
+* `DOMAIN`: Custom domain.
+* `ROOMID`: A default room ID new Jitsi Meet appointments get assigned.
+* `REQNAME`: Require name by default in new Jitsi Meet appointments. (True/False)
+* `NOAUDIO`: Mute audio by default in new Jitsi Meet appointments. (True/False)
+* `NOVIDEO`: Disable video by default in new Jitsi Meet appointments. (True/False)
+
+Example install command: `msiexec /i "C:\Downloads\JitsiMeetOutlook-v0.4.0-windows-x64.msi" TARGETDIR="C:\Program Files (x86)\Jitsi Meet Outlook" DOMAIN="my.domain.com" ROOMID="PermanentRoomName" REQNAME="True" NOAUDIO="True" NOVIDEO="True" /passive`
+
+All settings can be changed from the settings menu after installation.
## Roadmap
The published code and installer is still at an early stage. Preliminarily, the following amendments are in the pipeline:
-- [ ] Add possibility for preconfiguration of settings via silent installs
- [ ] Add RTF body text to appointment for improved appearance
- [ ] Shift the controls in the appointment ribbon to the left
- [ ] Add checks for Outlook having been installed on the target computer and that its architecture matches that of the installer
- [ ] Add persistent setting: add URL to Location field of appointment
- [ ] Add setting allowing users to generate random strings instead of random combinations of words
+- [ ] Add possibility for preconfiguration of settings via silent installs (v0.4.0)
- [x] Make the installation procedure less painful (v0.2.0)
- [x] Add small icons to the buttons in the appointment ribbon (v0.2.0)
- [x] Add a button for starting a conference with video muted to appointment tab (v0.2.0)