From 900564a6815392dbeb92fd6f4efff4acfb00a8b2 Mon Sep 17 00:00:00 2001
From: Petri Paavola <petri@petripaavola.fi>
Date: Tue, 7 Mar 2023 20:27:27 +0200
Subject: [PATCH] Update README.md

Initial version
---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 56 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2f27876..517a062 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,56 @@
-# Get-IntuneManagementExtensionDiagnostics
-Get-IntuneManagementExtensionDiagnostics script analyzes Intune IME logs and shows events in Timeline
+# Get-IntuneManagementExtensionDiagnostics #
+Go to script [Get-IntuneManagementExtensionDiagnostics.ps1](./Get-IntuneManagementExtensionDiagnostics.ps1)
+
+This script **analyzes** Microsoft Intune Management Extension (IME) log(s) and creates timeline report from found actions.
+
+Timeline report includes information about Intune events
+*  **Win32App**
+*  **WinGetApp**
+*  **Powershell scripts**
+*  **Proactive Remedation scripts**
+*  **custom Compliance Policy scripts**
+
+Windows Autopilot ESP phases and other information is also shown on timeline.
+
+### Usage: ###
+Download script from PowershellGallery with command:  
+```
+Save-Script Get-IntuneManagementExtensionDiagnostics -Path ./
+```
+Run script  
+```
+./Get-IntuneManagementExtensionDiagnostics.ps1
+  or
+./Get-IntuneManagementExtensionDiagnostics.ps1 -Online
+```
+
+There are many more Parameters but these should get you started.
+
+Powershell command outputs and errors can be also shown in Timeline view with parameters **-ShowStdOutInTimeline** and **-ShowErrorsInTimeline**
+This shows instantly what is problem in Powershell scripts
+
+**In Autopilot Shift-F10 Command Prompt during Autopilot Pre-Provisioning or Enrollment Status Page**  
+```
+Powershell.exe
+cd C:\ProgramData
+Set-ExecutionPolicy bypass -Scope Prosess
+Save-Script Get-IntuneManagementExtensionDiagnostics -Path ./
+./Get-IntuneManagementExtensionDiagnostics.ps1
+
+# Or to get displayName to scripts
+./Get-IntuneManagementExtensionDiagnostics.ps1 -Online
+```
+### LogViewerUI - better than cmtrace.exe ?-) ###
+
+Script also includes really capable Log Viewer UI if scripts is started with parameter **-ShowLogViewerUI**
+```
+./Get-IntuneManagementExtensionDiagnostics.ps1 -Online -ShowLogViewerUI
+```
+LogViewerUI (Out-GridView) looks a lot like cmtrace.exe tool but it is better because all found Timeline events are added to log for easier debugging.
+   
+LogViewerUI has good search and filtering capabilities. Try to filter known log entries in Timeline:  
+**Add criteria -> ProcessruntTime -> is not empty**
+   
+Selecting last line (RELOAD) and OK will reload log file.
+   
+Script can merge multiple log files so especially in LogViewerUI you can see Powershell command outputs from AgentExecutor.log