From 8e810c49813d9fae1ae72b7db869da16ccf21831 Mon Sep 17 00:00:00 2001 From: Alistair Young Date: Sat, 6 Mar 2021 15:10:11 -0600 Subject: [PATCH] Updated for command-line options. --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 28ee623..6af02de 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,28 @@ Check the "Settings..." checkbox to reveal the settings; these should be relativ To minimize Mouse Jiggler to the notification area, click the down-arrow button. -These settings are remembered from session to session. They can also be overridden by command-line options; for details, run `MouseJiggler -h`. +These settings are remembered from session to session. They can also be overridden by command-line options: + +``` +Usage: + MouseJiggler [options] + +Options: + -j, --jiggle Start with jiggling enabled. + -m, --minimized Start minimized (sets persistent option). [default: False] + -z, --zen Start with zen (invisible) jiggling enabled (sets persistent option). [default: False] + -s, --seconds Set number of seconds for the jiggle interval (sets persistent option). [default: 1] + --version Show version information + -?, -h, --help Show help and usage information +``` The `-j` command-line switch tells Mouse Jiggler to commence jiggling immediately on startup. +Bugs +==== + +When installed using Chocolatey, command-line help may not be displayed properly. See "installation" above. + Features That Will Not Be Implemented =====================================