Skip to content

Commit ecf0e81

Browse files
committed
Add deprecated options to README
1 parent 576c948 commit ecf0e81

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ allows you to run your Cypress tests on BrowserStack.
1212
- [Configure Test Runs](#configure-test-runs)
1313
- [Configure Connection Settings](#configure-connection-settings)
1414
- [Disable Usage Reporting](#disable-usage-reporting)
15+
- [Deprecated Options](#deprecated-options)
1516
- [CLI Arguments & Flags](#cli-arguments--flags)
1617
- [Run the Tests](#run-the-tests)
1718
- [Get the Build Information](#get-the-build-information)
@@ -219,6 +220,18 @@ Example:
219220
}
220221
```
221222

223+
### Deprecated Options
224+
225+
The following options are deprecated in favour of the new improved options to
226+
make your testing better, flexible and have a consistent way of specifying
227+
options.
228+
229+
| Deprecated option | New favoured option | Remarks |
230+
| ----------------- | ------------------- | ----------------------------- |
231+
| `specs` | `cypress_proj_dir` | Used in `run_settings` |
232+
| `customBuildName` | `custom_build_name` | Used in `run_settings` |
233+
| `localIdentifier` | `local_identifier` | Used in `connection_settings` |
234+
222235
## CLI Arguments & Flags
223236

224237
### Run the Tests

0 commit comments

Comments
 (0)