# Scanner
[![NPM version][npm-image]][npm-url]
[![build status][circle-image]][circle-url]
[![license][license-image]][license-url]

A cross-platform scanner for wireless networks.

## Installation

    $ npm install network-scanner

## Example

```js
var Scanner = require('network-scanner');
var scanner = Scanner();

scanner.scan(function(err, networks) {
  // [
  //  { ssid: 'Home', bssid: '2d:9e:c8:4d:b7', channel: '11' },
  //  { ssid: 'Work', bssid: '1f:3a:5b:1c:9b', channel: '8' },
  //  { ssid: 'Starbucks', bssid: '7b:3a:2e:8f:4c', channel: '3' }
  // ]
});
```

## Note

If you are running Linux, and you do not have `wireless-tools` installed, then install them with:

`apt-get install wireless-tools`

## License

[MIT](https://tldrlegal.com/license/mit-license)

[npm-image]: https://img.shields.io/npm/v/network-scanner.svg?style=flat-square
[npm-url]: https://npmjs.org/package/network-scanner
[circle-image]: https://img.shields.io/circleci/project/stevenmiller888/scanner.svg
[circle-url]: https://circleci.com/gh/stevenmiller888/scanner
[license-image]: https://img.shields.io/npm/l/express.svg
[license-url]: https://tldrlegal.com/license/mit-license