updated docs, renamed wifiNetworks

CHANGELOG.md

@@ -30,7 +30,8 @@ For major (breaking) changes - version 3 and 2 see end of page.
 
 | Version        | Date           | Comment  |
 | -------------- | -------------- | -------- |
-| 4.11.0         | 2019-06-14     | `wifi()` added available wifi networks |
+| 4.11.1         | 2019-06-15     | updated docs |
+| 4.11.0         | 2019-06-14     | `wifiNetworks()` added available wifi networks |
 | 4.10.0         | 2019-06-14     | `graphics()` windows multiple display support |
 | 4.9.2          | 2019-06-12     | type definitions bug fix |
 | 4.9.1          | 2019-06-11     | `networkStats()` bug fix windows |

README.md

@@ -82,7 +82,7 @@ si.cpu()
 
 (last 7 major and minor version releases)
 
-- Version 4.11.0: `wifi()` added available wifi networks
+- Version 4.11.0: `wifiNetworks()` added available wifi networks
 - Version 4.10.0: `graphics()` added windows multiple display support, added display size, connection, ...
 - Version 4.9.0: `graphics()` added vendor, refresh rate, current resolution
 - Version 4.8.0: added `vboxInfo()` detailed virtual box info
@@ -459,7 +459,7 @@ I also created a nice little command line tool called [mmon][mmon-github-url]  (
 #### 11. Wifi networks
 | Function        | Result object | Linux | BSD | Mac | Win | Sun | Comments |
 | --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
-| si.wifi(cb) | [{...}] | X |  | X | X |  | array of available wifi networks |
+| si.wifiNetworks(cb) | [{...}] | X |  | X | X |  | array of available wifi networks |
 | | [0].ssid | X |  | X | X |   | Wifi network SSID |
 | | [0].bssid | X |  | X | X |   | BSSID (mac) |
 | | [0].mode | X |  |   |   |   | mode |

docs/history.html

@@ -83,6 +83,11 @@
                   </tr>
                 </thead>
                 <tbody>
+                  <tr>
+                    <th scope="row">4.11.1</th>
+                    <td>2019-06-15</td>
+                    <td>updated docs</td>
+                  </tr>
                   <tr>
                     <th scope="row">4.11.0</th>
                     <td>2019-06-14</td>

docs/wifi.html

@@ -66,7 +66,7 @@
                 </thead>
                 <tbody>
                   <tr>
-                    <td>si.wifi(cb)</td>
+                    <td>si.wifiNetworks(cb)</td>
                     <td>[{...}]</td>
                     <td>X</td>
                     <td>X</td>

lib/index.d.ts

@@ -639,7 +639,7 @@ export function networkConnections(cb?: (data: Systeminformation.NetworkConnecti
 export function inetChecksite(url: string, cb?: (data: Systeminformation.InetChecksiteData) => any): Promise<Systeminformation.InetChecksiteData>;
 export function inetLatency(host?: string, cb?: (data: number) => any): Promise<number>;
 
-export function wifi(cb?: (data: Systeminformation.WifiNetworkData[]) => any): Promise<Systeminformation.WifiNetworkData[]>;
+export function wifiNetworks(cb?: (data: Systeminformation.WifiNetworkData[]) => any): Promise<Systeminformation.WifiNetworkData[]>;
 
 export function users(cb?: (data: Systeminformation.UserData[]) => any): Promise<Systeminformation.UserData[]>;
 

lib/wifi.js

@@ -110,7 +110,7 @@ function wifiFrequencyFromChannel(channel) {
   return frequencies.hasOwnProperty(channel) ? frequencies[channel] : -1;
 }
 
-function wifi(callback) {
+function wifiNetworks(callback) {
 
   return new Promise((resolve) => {
     process.nextTick(() => {
@@ -238,4 +238,4 @@ function wifi(callback) {
   });
 }
 
-exports.wifi = wifi;
+exports.wifiNetworks = wifiNetworks;

package.json

@@ -62,7 +62,12 @@
     "gpu",
     "display",
     "smart",
-    "disk layout"
+    "disk layout",
+    "wifi",
+    "wifinetworks",
+    "virtual box",
+    "virtualbox",
+    "vm"
   ],
   "repository": {
     "type": "git",