From 69cb01b0a1ee5a6a9da4e65b016576c9897a25f3 Mon Sep 17 00:00:00 2001
From: Aaron Viehl <Admonstrator@users.noreply.github.com>
Date: Sat, 5 Feb 2022 11:46:27 +0100
Subject: [PATCH] Added readme, fixed typo

---
 msoffice-removal-tool.ps1 |  6 +++---
 readme.md                 | 23 +++++++++++++++++++++++
 2 files changed, 26 insertions(+), 3 deletions(-)
 create mode 100644 readme.md

diff --git a/msoffice-removal-tool.ps1 b/msoffice-removal-tool.ps1
index fea31f0..5db44bc 100644
--- a/msoffice-removal-tool.ps1
+++ b/msoffice-removal-tool.ps1
@@ -9,7 +9,7 @@
   By choosing -InstallOffice365 it tries to install Office 365 as well.
 .PARAMETER InstallOffice365
   Will install Office365 after removal.
-.PARAMETER SupressReboot
+.PARAMETER SuppressReboot
   Will supress the reboot after finishing the script.
 .PARAMETER UseSetupRemoval
   Will use the setup methode to remove current Office installations instead of SaRA.
@@ -31,7 +31,7 @@
 #---------------------------------------------------------[Initialisations]--------------------------------------------------------
 Param (
     [switch]$InstallOffice365 = $False,
-    [switch]$SupressReboot = $False,
+    [switch]$SuppressReboot = $False,
     [switch]$UseSetupRemoval = $False,
     [Switch]$Force = $False
 )
@@ -150,7 +150,7 @@ Function Invoke-SetupOffice365($Office365ConfigFile) {
 }
 
 Function Invoke-Reboot {
-    if (-not $SupressReboot) {
+    if (-not $SuppressReboot) {
         Start-Process -FilePath "$env:SystemRoot\system32\shutdown.exe" -ArgumentList "/r /c `"Reboot needed. System will reboot in 60 seconds.`" /t 60 /f /d p:4:1"
     }
 }
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..415f220
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,23 @@
+# Microsoft Office Removal Tool
+
+## Synopsis
+This script downloads the current Office uninstaller from Microsoft and tries to remove all Office installations on this computer. If you wish it tries to install the newest Office365 build as well.
+
+## Parameter
+
+| Parameter | Usage  |
+|---|---|
+|  -InstallOffice365 | The script will try to install the newest Office365 build after removal  |
+| -SuppressReboot | No reboot will be executed after script is done|
+| -UseSetupRemoval | Will use the official Office365 setup instead of SaRA|
+|-Force | Non-interactive - No user interaction required|
+
+### Notes
+  Version:  1.0
+  
+  Author: aaron.viehl@frankfurt.einsnulleins.de
+  
+  Creation Date: 2022-02-04
+
+### Example
+  ``.\msoffice-removal-tool.ps1 -InstallOffice365 -SuppressReboot -Force``
\ No newline at end of file