Skip to content

Commit cc968e6

Browse files
committed
Merge pull request #128 from akhillb/browsers_documentation
Updated README for "browsers" option Closes #113
2 parents 4edfe6a + e73722e commit cc968e6

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,39 @@ A sample configuration file:
6868
}
6969
```
7070

71+
#### `browsers` parameter
72+
73+
`browsers` parameter is a list of objects, where each object contains the details of the browsers on which you want to run your tests. This object differs for browsers on desktop platforms and browsers on mobile platforms. Browsers on desktop platform should contain `browser`, `browser_version`, `os `, `os_version` parameters set as required.
74+
75+
Example:
76+
```json
77+
{
78+
"browser": "ie",
79+
"browser_version": "10.0",
80+
"os": "Windows",
81+
"os_version": "8"
82+
}
83+
```
84+
85+
For mobile platforms, `os`, `os_version` and `device` parameters are required.
86+
87+
Example:
88+
```json
89+
[{
90+
"os": "ios",
91+
"os_version": "8.3",
92+
"device": "iPhone 6 Plus"
93+
},
94+
{
95+
"os": "android",
96+
"os_version": "4.0",
97+
"device": "Google Nexus"
98+
}
99+
]
100+
```
101+
102+
For a full list of supported browsers, platforms and other details, [visit the BrowserStack site](https://www.browserstack.com/list-of-browsers-and-platforms?product=automate).
103+
71104
#### Compact `browsers` configuration
72105

73106
When `os` and `os_version` granularity is not desired, following configuration can be used:
@@ -99,6 +132,8 @@ Example:
99132
]
100133
}
101134
```
135+
**Note:**
136+
These shortcuts work only for browsers on desktop platforms supported by BrowserStack.
102137

103138
### Proxy support for BrowserStack local
104139

0 commit comments

Comments
 (0)