screen-info/readme.md

Multiplatform screen & monitors info

# screen-info

> A native multiplatform module to query the system OS for displays info.

## Usage

Get current screen info & print it to console:

```js
import Screen from '.';

const mainScreen = Screen.main();
console.log(`
	Current screen size is ${mainScreen}
	${mainScreen.width} pixels width,
	${mainScreen.height} pixels height,
	${mainScreen.colorDepth} bits per pixels
`);
```

This will output

```
	Current screen size is 1920x1080x24
	1920 pixels width,
	1080 pixels height,
	24 bits per pixels
```

[![Travis Build Status](https://img.shields.io/travis/parro-it/screen-info/master.svg)](http://travis-ci.org/parro-it/screen-info)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/0j904vwgk43vuh3h?svg=true)](https://ci.appveyor.com/project/parro-it/screen-info)[![NPM downloads](https://img.shields.io/npm/dt/screen-info.svg)](https://npmjs.org/package/screen-info)


## API

```js
main: () => {width:number, height: number, colorDepth: number}
```

return the size and color depth of default system display

```js
all: () => [{width:number, height: number, colorDepth: number}]
```

return the size and color depth of all system displays

## Install

With [npm](https://npmjs.org/) installed, run

```
$ npm install screen-info
```

## See Also

- [`noffle/common-readme`](https://github.com/noffle/common-readme)

## License

MIT