diff --git a/README.md b/README.md index 7d7ed90..9fb3892 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ # Toast + +**Screenshots** http://byteben.com/bb/wp-content/uploads/2020/07/Toast-Example.jpg http://byteben.com/bb/wp-content/uploads/2020/07/Content-Example.jpg +**Description** Toast_Notify.ps1 is a simple Toast Notification script designed to be deployed as a package from MEMCM. The "Set and forget" mentality of packages works really well because we don't need to specify a detection method once the script has run. -Toast_Notify.ps1 will read an XML file on a file share so Toast Notifications can be changed "on the fly" without having to repackage. -To create a custom XML, copy CustomMessage.xml and edit the text you want to display in the toast notification. Reference that file using one of the script parameters. +Toast_Notify.ps1 will read an XML file on a file share or from the same directory. If the XML is stored on a fileservr, theo Toast Notifications can be changed "on the fly" without having to repackage the script. +To create a custom XML, copy CustomMessage.xml and edit the text you want to display in the toast notification. Place the modified XML in the script directory or on a fileserver. Call your custom file using one of the script parameters below. **Points to Consider** I am using an existing app in Windows to call the Toasts. This script creates two buttons in the Toast, "Details" and "Dismiss". Cicking details is designed to take the user to an internal Service Desk announcement page. For that reason, **MSEdge** works really well because the Toast Action launches the browser in the foreground. Oh, you will need MSEdge installed on your client computers for this to work. @@ -18,12 +21,14 @@ BadgeImage.jpg HeroImage.jpg CustomMessage.xml** +**Parameters** +You should specify either XMLScriptSourceDir **or** XMLOtherSource parameters but not both. If you specify no parameter the script will read the CustomMessage.xml in the script root. **.PARAMETER XMLScriptDirSource** Specify the name of the XML file to read. The XML file must exist in the same directory as Toast_Notify.ps1. If no parameter is passed, it is assumed the XML file is called CustomMessage.xml. **.PARAMETER XMLOtherSource** -Specify the location of the Custom XML file used for the Toast when it is not in the MEMCM package +Specify the location of the Custom XML file used for the Toast when it is not the same directory as Toast_Notify.ps1 e.g the full UNC path to the XML file. **.EXAMPLE** Toast_Notify.ps1 -XMLOtherSource "\\\\fileserverhome\xml\CustomMessage.xml" @@ -35,7 +40,7 @@ Toast_Notify.ps1 -XMLSciptDirSource "PhoneSystemProblems.xml" Toast_Notify.ps1 **Known Issues** -Currently, the images in the XML can only be read from the local files system. This is not an issue if we are deploying the package from MEMCM. Further development will see the ability to convert images to Base64 or host them on a web server. +Currently, the images in the XML can only be read from the local file system. This is not an issue if we are deploying the package from MEMCM. **Thanks for the help from** @guyrleech