commit 4d4e3c9cb6bf6cdfc965761eee9e9e70fd18a9a3 parent 628a5756a2c0021a01faeb9102eadffc039cabf8 Author: Jack Mordaunt <jackmordaunt.dev@gmail.com> Date: Wed, 22 Mar 2023 12:25:40 +0800 readme: explain the packages Signed-off-by: Jack Mordaunt <jackmordaunt.dev@gmail.com> Diffstat:
| M | README.md | | | 7 | +++++++ |
1 file changed, 7 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -6,6 +6,13 @@ The XML schema used to describe such notifications is here: https://learn.microsoft.com/en-us/windows/apps/design/shell/tiles-and-notifications/adaptive-interactive-toasts +Package `wintoast` offers a lower-level api. +Package `toast` offers a higher-level wrapper. + +`wintoast` uses build tags to guard Windows only code. It will still compile on +non-Windows platforms, however the functions are stubbed out and will do nothing +when invoked. + ## Usage ### Basic