From 99718ae5aacaac8ef3d4a6fd26accb39415e1ff9 Mon Sep 17 00:00:00 2001 From: Luke Tainton Date: Sat, 18 Apr 2020 20:07:09 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20DOC:=20Module=20published=20to?= =?UTF-8?q?=20PowerShell=20Gallery?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Luke Tainton --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 107cd6a..56f9569 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,18 @@ A Powershell script that imports users from a CSV into a Microsoft Teams team. # Setting up your device -This script runs via PowerShell. If you're on Windows, you'll already have this. If not, please download it from the [releases page](https://github.com/PowerShell/PowerShell/releases). Once you've got PowerShell: +This script runs via PowerShell, which is pre-installed on Windows. If you're not on Windows, please download **PowerShell Core** [here](https://github.com/PowerShell/PowerShell/releases). Once you've got PowerShell: 1. Open PowerShell as an administrator. -2. Allow remote scripts to execute by running `Set-ExecutionPolicy RemoteSigned`. If you don't do this, the script won't run. -3. Install the Microsoft Teams module. To do this, run `Install-Module -Name MicrosoftTeams`. Accept any prompts that you are given. +1. Allow remote scripts to execute by running `Set-ExecutionPolicy RemoteSigned`. If you don't do this, the script won't run. +1. Install the Microsoft Teams module. To do this, run `Install-Module -Name MicrosoftTeams`. Accept any prompts that you are given. +1. Install this module by running `Install-Module -Name Import-TeamsUsers`. Accept any prompts that you are given. # Running the script -1. Download the repository to your PC. -2. Create a CSV file in the format `email,role`. The first line must be the headers `email,role`. You can copy the template if required. -3. Open PowerShell and change directory (`cd`) to the directory where you downloaded the repository. -3. Import the module (`Import-Module ./Import-TeamsUsers.psm1`). -4. Run `Import-TeamsUsers -File `. +1. Create a CSV file in the format `email,role`. The first line must be the headers `email,role`. You can copy the template if required. +1. Open PowerShell and run `Import-TeamsUsers -File `, where `` is the full path to the CSV file. # Need help? -If you require assistance running the script, see the help by executing `Get-Help Import-TeamsUsers` (requires importing the module first - see steps 3 and 4 above). If you still need help, please [send me an email](mailto:luke@tainton.uk?subject=I%20need%20help%20running%20Import-TeamsUsers). +If you require assistance running the script, see the help by executing `Get-Help Import-TeamsUsers` (requires importing the module first - see step 4 in _Setting up your device_). If you still need help, please [send me an email](mailto:luke@tainton.uk?subject=I%20need%20help%20running%20Import-TeamsUsers). # Issues? Want a new feature? If you're having problems with the script or have an idea for a new feature, please check [here](https://github.com/luketainton/Import-TeamsUsers/issues) to see if someone else has the same problem or suggestion, and open an issue if one doesn't already exist. If you can implement a fix or feature request, please file a pull request!