Skip to content

Commit b75b421

Browse files
committed
Merge pull request #44 from browserstack/readme_update
README update for new browser config
2 parents 2896f4d + fd2526b commit b75b421

File tree

1 file changed

+70
-50
lines changed

1 file changed

+70
-50
lines changed

README.md

Lines changed: 70 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -44,55 +44,75 @@ If nothing is provided as `preset` **default** is used.
4444

4545
A sample configuration file:
4646

47-
{
48-
"username": "<username>",
49-
"key": "<key>",
50-
"test_framework": "qunit/jasmine/mocha",
51-
"test_path": ["relative/path/to/test/page1", "relative/path/to/test/page2"],
52-
"browsers": [{
53-
"browser": "firefox",
54-
"browser_version": "15.0",
55-
"device": null,
56-
"os": "OS X",
57-
"os_version": "Snow Leopard"
58-
},
59-
{
60-
"browser": "firefox",
61-
"browser_version": "16.0",
62-
"device": null,
63-
"os": "Windows",
64-
"os_version": "7"
65-
},
66-
{
67-
"browser": "firefox",
68-
"browser_version": "17.0",
69-
"device": null,
70-
"os": "Windows",
71-
"os_version": "8"
72-
},
73-
{
74-
"browser": "ie",
75-
"browser_version": "8.0",
76-
"device": null,
77-
"os": "Windows",
78-
"os_version": "7"
79-
},
80-
{
81-
"browser": "ie",
82-
"browser_version": "9.0",
83-
"device": null,
84-
"os": "Windows",
85-
"os_version": "7"
86-
},
87-
{
88-
"browser": "ie",
89-
"browser_version": "10.0",
90-
"device": null,
91-
"os": "Windows",
92-
"os_version": "8"
93-
}]
94-
}
95-
47+
```json
48+
{
49+
"username": "<username>",
50+
"key": "<key>",
51+
"test_framework": "qunit/jasmine/mocha",
52+
"test_path": ["relative/path/to/test/page1", "relative/path/to/test/page2"],
53+
"browsers": [{
54+
"browser": "firefox",
55+
"browser_version": "15.0",
56+
"device": null,
57+
"os": "OS X",
58+
"os_version": "Snow Leopard"
59+
},
60+
{
61+
"browser": "firefox",
62+
"browser_version": "16.0",
63+
"device": null,
64+
"os": "Windows",
65+
"os_version": "7"
66+
},
67+
{
68+
"browser": "firefox",
69+
"browser_version": "17.0",
70+
"device": null,
71+
"os": "Windows",
72+
"os_version": "8"
73+
},
74+
{
75+
"browser": "ie",
76+
"browser_version": "8.0",
77+
"device": null,
78+
"os": "Windows",
79+
"os_version": "7"
80+
},
81+
{
82+
"browser": "ie",
83+
"browser_version": "9.0",
84+
"device": null,
85+
"os": "Windows",
86+
"os_version": "7"
87+
},
88+
{
89+
"browser": "ie",
90+
"browser_version": "10.0",
91+
"device": null,
92+
"os": "Windows",
93+
"os_version": "8"
94+
}]
95+
}
96+
```
97+
98+
Alternatively, if `os` and `os_version` granularity is not desired, following configuration can be used:
99+
- *browser*_current: will assign the latest version of the *browser*.
100+
- *browser*_previous: will assign the previous version of the *browser*.
101+
- *browser*_*version*: will assign the *version* specificed of the *browser*. Minor versions can be concatinated with underscore.
102+
103+
Example:
104+
```json
105+
"browsers": [
106+
"chrome_previous",
107+
"chrome_current",
108+
"firefox_previous",
109+
"firefox_current",
110+
"ie_6",
111+
"ie_11",
112+
"opera_12_1",
113+
"safari_5_1"
114+
]
115+
```
96116

97117
### Enviroment variables
98118

@@ -124,4 +144,4 @@ Run `browserstack-runner` to run the tests on all the browsers mentioned
124144
in the configuration.
125145

126146
You can include this in your test script to automatically run cross
127-
browser tests on every build.
147+
browser tests on every build.

0 commit comments

Comments
 (0)