Skip to content

Commit b276aef

Browse files
committed
doc: Update README.md. (#19)
1 parent e251d25 commit b276aef

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
11
# win-toast-cli
22

3-
Invoke toast notification by output of another application.
3+
Invoke toast notification by command-line.
4+
5+
## Usage
6+
7+
On PowerShell console,
8+
9+
```powershell
10+
> toast-cli.ps1 -body "Body message"
11+
```
12+
13+
### Options
14+
15+
- `-body string`: String for toast notification body
16+
- `-title string`: String for toast notification title (optional)
17+
- `-detail string`: String for toast notification detail (optional)
18+
- `-?`: Show help
19+
20+
## Contents
21+
22+
- `toast-cli.ps1`: PowerShell script to show toast notification
23+
- `toast-cli.cmd`: Batch wrapper to `toast-cli.ps1`.
24+
This makes easy to invoke from command prompt.
25+
- `tools/toast-scoop-status.ps1`:
26+
Sample tool to show application updates installed by [scoop](https://scoop.sh)

0 commit comments

Comments
 (0)