From ecf0e817d99d8e67b5a12b5567ffb48650b03355 Mon Sep 17 00:00:00 2001 From: Sreyantha Chary Date: Mon, 11 May 2020 19:15:50 +0530 Subject: [PATCH] Add deprecated options to README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 05e248e8..fe005d1e 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ allows you to run your Cypress tests on BrowserStack. - [Configure Test Runs](#configure-test-runs) - [Configure Connection Settings](#configure-connection-settings) - [Disable Usage Reporting](#disable-usage-reporting) + - [Deprecated Options](#deprecated-options) - [CLI Arguments & Flags](#cli-arguments--flags) - [Run the Tests](#run-the-tests) - [Get the Build Information](#get-the-build-information) @@ -219,6 +220,18 @@ Example: } ``` +### Deprecated Options + +The following options are deprecated in favour of the new improved options to +make your testing better, flexible and have a consistent way of specifying +options. + +| Deprecated option | New favoured option | Remarks | +| ----------------- | ------------------- | ----------------------------- | +| `specs` | `cypress_proj_dir` | Used in `run_settings` | +| `customBuildName` | `custom_build_name` | Used in `run_settings` | +| `localIdentifier` | `local_identifier` | Used in `connection_settings` | + ## CLI Arguments & Flags ### Run the Tests