Skip to content

Commit f58c9a2

Browse files
authored
(maint) Update README with v1.0.0 notice
v1.0.0 is going to rock the boat a little. Need to make it as obvious as possible not to blindly update.
1 parent f7662e1 commit f58c9a2

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@
1111

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

14+
## ❗❗❗ NOTICE ❗❗❗
15+
16+
BurntToast v1.0.0 will include **numerous** breaking changes and your existing scripts **will not** work without changes.
17+
18+
**DO NOT** upgrade to BurntToast v1.0.0 until you are ready.
19+
20+
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)
21+
1422
## Install
1523

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

2735
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.)
2836

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

3139
*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`.*
3240

0 commit comments

Comments
 (0)