Skip to content

Commit 096f109

Browse files
authored
Update README.md - Add Chromium documentation (#471)
1 parent 35b2091 commit 096f109

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ npm install -g cordova-simulate
3131
From the command line anywhere within a Cordova project, enter the following:
3232

3333
```
34-
simulate [<platform>] [--device=<DEVICE_ID>] [--corsproxy=<true|false>] [--dir=<DIR>] [--livereload=<true|false>] [--port=<PORT>] [--forceprepare=<true|false>] [--simhostui=<SIM_HOST_UI_MODULE_PATH>] [--simulationpath=<SIMULATION_PATH>] [--target=<BROWSER>] [--lang=<LANG>] [--theme=<THEME>] [--middleware=<MIDDLEWARE_PATH>] [--generateids=<true|false>] [--spaurlrewrites=<true|false>] [--showbrowser=<true|false>]
34+
simulate [<platform>] [--device=<DEVICE_ID>] [--corsproxy=<true|false>] [--dir=<DIR>] [--livereload=<true|false>] [--port=<PORT>] [--forceprepare=<true|false>] [--simhostui=<SIM_HOST_UI_MODULE_PATH>] [--simulationpath=<SIMULATION_PATH>] [--target=<BROWSER>] [--lang=<LANG>] [--theme=<THEME>] [--middleware=<MIDDLEWARE_PATH>] [--generateids=<true|false>] [--spaurlrewrites=<true|false>] [--showbrowser=<true|false>] [--chromiumpath=<CHROMIUM_PATH>]
3535
```
3636

3737
See parameters description in the [API](#api) section.
@@ -54,7 +54,7 @@ Where `opts` is an object with the following properties (all optional):
5454
Supported `windows` devices are `Lumia930`, `Lumia950` and `SurfacePro`. Supported generic devices (which will use the
5555
`browser` platform) are `Generic320x480`, `Generic320x568`, `Generic360x640`, `Generic384x640`, `Generic412x732`,
5656
`Generic768x1024`, `Generic800x1280` and `Generic1920x1080`.
57-
* **target** - the name of the browser to launch your app in. Can be any of the following: `default`, `chrome`, `edge`, `firefox`, `opera`, `safari`.
57+
* **target** - the name of the browser to launch your app in. Can be any of the following: `default`, `chrome`, `edge`, `firefox`, `opera`, `safari`, `chromium`.
5858
* **port** - the desired port for the server to use. Defaults to `8000`.
5959
* **lang** - the language to display in the interface (does not impact console output). Supported values (case-insensitive)
6060
are `cs` (Czech), `de` (German), `es` (Spanish), `fr` (French), `it` (Italian), `ja` (Japanese), `ko` (Korean), `pl` (Polish),
@@ -73,13 +73,14 @@ Where `opts` is an object with the following properties (all optional):
7373
* **livereloaddelay** - the delay in milliseconds between saving of a modified file and the application page reloading. You can try to increase the delay in case the simulator server crashes while frequent page reloading. Defaults to `200ms`.
7474
* **spaurlrewrites** - a boolean. Set to `true` to fix page refreshing in case the default application URL (`/index.html`) in the browser was changed by the router in single page applications. Defaults to `false`.
7575
* **showbrowser** - a boolean. Set to `true` to launch browsers when simulation starts. Defaults to `true`.
76+
* **chromiumpath** - a path that points to Chromium executable file. Required when using Chromium as `target` on `win32`.
7677

7778
Use `launchBrowser` to open target browser with specific url:
7879

7980
```JavaScript
8081
require('cordova-simulate').launchBrowser(target, url);
8182
```
82-
* **target** - which browser you want to open, like `Chrome`, `Edge`, `Firefox`, `Opera`, `Safari`.
83+
* **target** - which browser you want to open, like `Chrome`, `Edge`, `Firefox`, `Opera`, `Safari`, `Chromium`.
8384
* **url** - specific website url you want to load.
8485

8586
# What it does

0 commit comments

Comments
 (0)