Skip to content

Commit

Permalink
Add deprecated options to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Sreyanth committed May 11, 2020
1 parent 576c948 commit ecf0e81
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ecf0e81

Please sign in to comment.