Skip to content

Commit 3efaebc

Browse files
committed
Update Readme
1 parent 8bc5804 commit 3efaebc

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[![npm](https://img.shields.io/npm/v/electron-viewport.svg)]() [![npm](https://img.shields.io/npm/dt/electron-viewport.svg)]() [![npm](https://img.shields.io/npm/l/electron-viewport.svg)]()
22

33
# electron-viewport
4-
electron-viewport helps scale and emulate viewports. To use electron-viewport, first install it
4+
electron-viewport helps emulate and scale viewports. Viewport can emulate a device viewport, such as emulating a phone device or 4k display, and can scale a window (maintaining aspect ratio) to fit on screen.
55

66
### Installation
77
`npm install --save electron-viewport`
@@ -33,21 +33,22 @@ Creates and returns a [BrowserWindow](https://github.com/electron/electron/blob/
3333
### Getting scaled width and height
3434

3535
```javascript
36-
var { width, height } = require('./viewport.js')(width, height)
36+
var { width, height } = require('electron-viewport')(width, height)
3737
```
38+
Simply returns scaled dimensions so you may create your own window.
3839

3940
### Creating a scaled window
4041

4142
```javascript
42-
var viewport = require('./viewport.js')(width, height)
43+
var viewport = require('electron-viewport')(width, height)
4344
var mainWindow = viewport.getWindow()
4445
```
4546
Creates a scaled BrowserWindow which fits on screen, with the width and height specified.
4647

4748
### Scaled window with device emulation
4849

4950
```javascript
50-
var viewport = require('./viewport.js')(deviceWidth, deviceHeight, true)
51+
var viewport = require('electron-viewport')(deviceWidth, deviceHeight, true)
5152
var mainWindow = viewport.getWindow()
5253
```
5354
Creates a scaled BrowserWindow which fits on screen, with device emulation enabled for the passed width and height.
@@ -56,7 +57,7 @@ Creates a scaled BrowserWindow which fits on screen, with device emulation enabl
5657

5758
```javascript
5859
var options = { frame: false } //specify your BrowserWindow options here, just an example
59-
var viewport = require('./viewport.js')(width, height, options)
60+
var viewport = require('electron-viewport')(width, height, options)
6061
var mainWindow = viewport.getWindow()
6162
```
6263
Creates a scaled BrowserWindow which fits on screen, with the given [BrowserWindow options](https://github.com/electron/electron/blob/master/docs/api/browser-window.md) being passed
@@ -65,7 +66,7 @@ Creates a scaled BrowserWindow which fits on screen, with the given [BrowserWind
6566

6667
```javascript
6768
var options = { frame: false } //specify your BrowserWindow options here, just an example
68-
var viewport = require('./viewport.js')(width, height, true, options)
69+
var viewport = require('electron-viewport')(width, height, true, options)
6970
var mainWindow = viewport.getWindow()
7071
```
7172

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "electron-viewport",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "Helps scale and emulate viewports in Electron",
55
"main": "viewport.js",
66
"scripts": {

0 commit comments

Comments
 (0)