Skip to content

Commit

Permalink
(maint) Update README with v1.0.0 notice
Browse files Browse the repository at this point in the history
v1.0.0 is going to rock the boat a little.
Need to make it as obvious as possible not to blindly update.
  • Loading branch information
Windos authored Feb 17, 2022
1 parent f7662e1 commit f58c9a2
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@

PowerShell Module for displaying **Windows 10** and **Windows Server 2019** Toast Notifications

## ❗❗❗ NOTICE ❗❗❗

BurntToast v1.0.0 will include **numerous** breaking changes and your existing scripts **will not** work without changes.

**DO NOT** upgrade to BurntToast v1.0.0 until you are ready.

You can read more about the up coming changes on [ToastIT.dev](https://toastit.dev/tag/burnttoast/) and BurntToast's new [Docs Site](https://docs.toastit.dev/changelog)

## Install

### PowerShell Gallery Install (Requires PowerShell v5)
Expand All @@ -26,7 +34,7 @@ Don't forget to set the correct [Execution Policy](https://docs.microsoft.com/en

Download [BurntToast.zip](https://github.com/Windos/BurntToast/releases/latest/download/BurntToast.zip) from [Releases page](https://github.com/Windos/BurntToast/releases/latest) and extract the contents into `$env:userprofile\Documents\WindowsPowerShell\modules\BurntToast` (you may have to create these directories if they don't exist.)

If you are using Powershell 6 or later, extract into `$env:userprofile\Documents\PowerShell\Modules\BurntToast`
If you are using PowerShell 6 or later, extract into `$env:userprofile\Documents\PowerShell\Modules\BurntToast`

*Please remember to "**unblock**" the zip file before extracting the contents. Not doing so will result in the module not working correctly. This can be done via the file properties or with `Unblock-File`.*

Expand Down

0 comments on commit f58c9a2

Please sign in to comment.