Document the check command

dhleong · dhleong · commit 12630615300a · 2019-03-13T09:40:05.000-04:00
1.8.4
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ ps4-waker - Wake your PS4 (and more!) with help from the Playstation App
 
 Usage:
   ps4-waker [options]                       Wake PS4 device(s)
+  ps4-waker [options] check                 Check a device's status
   ps4-waker [options] osk-submit [text]     Submit the OSK, optionally
                                             providing the text
   ps4-waker [options] remote <key-name...>  Send remote key-press event(s)
@@ -66,6 +67,14 @@ Device selection:
     4. Both -t and -d: Will search for at most <time> seconds for and only
        act on the provided device, qutting early if found.
 
+Checking device status:
+  The "check" command provides output similar to "search," but only for
+  the first matching device found (see above). In addition, it will exit
+  with code '0' only if the device is awake; if it is in standby, it
+  will exit with code '1', and in any other situation it will exit with
+  code '2'. This command is intended to simplify initial state detection
+  for home automation users.
+
 Key names:
   Button names are case insensitive, and can be one of:
     up, down, left, right, enter, back, option, ps
diff --git a/lib/cli.js b/lib/cli.js
@@ -31,6 +31,7 @@ ps4-waker - Wake your PS4 (and more!) with help from the Playstation App
 
 Usage:
   ps4-waker [options]                       Wake PS4 device(s)
+  ps4-waker [options] check                 Check a device's status
   ps4-waker [options] osk-submit [text]     Submit the OSK, optionally
                                             providing the text
   ps4-waker [options] remote <key-name...>  Send remote key-press event(s)
@@ -67,6 +68,14 @@ Device selection:
     4. Both -t and -d: Will search for at most <time> seconds for and only
        act on the provided device, qutting early if found.
 
+Checking device status:
+  The "check" command provides output similar to "search," but only for
+  the first matching device found (see above). In addition, it will exit
+  with code '0' only if the device is awake; if it is in standby, it
+  will exit with code '1', and in any other situation it will exit with
+  code '2'. This command is intended to simplify initial state detection
+  for home automation users.
+
 Key names:
   Button names are case insensitive, and can be one of:
     up, down, left, right, enter, back, option, ps
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "ps4-waker",
   "description": "Wake your PS4 over LAN (and more!) with help from the Playstation App",
-  "version": "1.8.3",
+  "version": "1.8.4",
   "author": "Daniel Leong",
   "license": "MIT",
   "main": "index.js",

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "ps4-waker",`
`3`	`3`	`"description": "Wake your PS4 over LAN (and more!) with help from the Playstation App",`
`4`		`- "version": "1.8.3",`
	`4`	`+ "version": "1.8.4",`
`5`	`5`	`"author": "Daniel Leong",`
`6`	`6`	`"license": "MIT",`
`7`	`7`	`"main": "index.js",`