wake_on_lan - npm Package Compare versions

Comparing version 0.0.5 to 1.0.0

package.json

 {
   "name": "wake_on_lan",
-  "version": "0.0.5",
+  "version": "1.0.0",
   "description": "generate and send Wake-on-LAN magic packets",
   "main": "./wake_on_lan.js",
-  "licenses": [
-    {
-      "type": "MIT",
-      "url": "http://github.com/agnat/node_wake_on_lan/raw/master/LICENSE"
-    }
-  ],
+  "license": "MIT",
   "bugs": {
     "url": "http://github.com/agnat/node_wake_on_lan/issues"
   },
+  "bin": {
+    "wake": "./wake"
+  },
   "repository": {
@@ -28,4 +26,11 @@ "type": "git",
       "github": "thejh"
+    },
+    {
+      "email": "[e-mail]",
+      "github": "mh-cbon"
     }
-  ]
+  ],
+  "dependencies": {
+    "minimist": "^1.2.0"
+  }
 }

README.md

@@ -5,5 +5,6 @@ # Wake-on-LAN utilities for node.js
 
+````bash
+npm install wake_on_lan --save  # use the library
+npm install wake_on_lan -g      # optional global wake utility 
 ````
-npm install wake_on_lan
-````
 
@@ -30,2 +31,4 @@ ## Synopsis
 
+See [windows notes](#windows-notes) and the [wake utility](#the-wake-utility).
+
 ## Reference
@@ -64,5 +67,40 @@
 
+## The wake utility
+
+````
+wake [options] MAC
+````
+
+### Options
+
+| Option | Short | Description | Default |
+| --- | --- | --- | --- |
+| --address | -a | Broadcast address, ipv4 or ipv6 | 255.255.255.255 |
+| --num_packets | -n | Number of packets to send | 3 |
+| --interval | -i | Interval between each packet | 100 |
+| --port | -p | UDP port of the target destination | 9 |
+| --help | -h | Show help ||
+
+### Examples
+
+````bash
+wake 20:DE:20:DE:20:DE
+wake -a 192.168.1.255 20-DE-20-DE-20-DE
+wake --num_packets 10 --interval 50 -p 9 20DE20DE20DE
+````
+
+## Windows Notes
+
+Because windows routes global broadcasts differently from unix systems, it is necessary to specify a broadcast address manually, e.g:
+
+````
+wol.wake(someMac, { address: "192.168.2.255" }, wakeCallback);
+````
+
+Use [`os.networkInterfaces()`](https://nodejs.org/api/os.html#os_os_networkinterfaces) to calculate the broadcast address dynamically. See [@mwittig's comment](https://github.com/agnat/node_wake_on_lan/issues/4#issuecomment-156404241) for further information.
+
 ## Contributors
 
-* Jann Horn ("@thejh":http://github.com/thejh)
+* Jann Horn [@thejh](http://github.com/thejh)
+* mh-cbon [@mh-cbon](http://github.com/mh-cbon)
 
@@ -78,2 +116,1 @@ ## License (MIT)
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

wake_on_lan.js

@@ -71,3 +71,3 @@ var dgram  = require('dgram')
   }
-  
+
   socket.on('error', post_write);
@@ -89,2 +89,1 @@
 }
-

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9228

increased by37.49%

Number of package files

6

increased by20%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

113

increased by48.68%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedminimist@^1.2.0

• + Addedminimist@1.2.8(transitive)