Skip to content

Commit 3951c50

Browse files
author
John Doherty
committed
updated Applitools content in readme and bumped minor version
1 parent b8df1f9 commit 3951c50

File tree

3 files changed

+9
-13
lines changed

3 files changed

+9
-13
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
.vscode
22
node_modules
3-
3+
package-lock.json
44
. idea/

README.MD

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# selenium-cucumber-js
2-
3-
[![Shippable branch](https://img.shields.io/shippable/5818b23bbd56670e00037040/master.svg)](https://app.shippable.com/projects/5818b23bbd56670e00037040) [![npm](https://img.shields.io/npm/dt/selenium-cucumber-js.svg)](https://www.npmjs.com/package/selenium-cucumber-js) [![Linked In](https://img.shields.io/badge/Linked-In-blue.svg)](https://www.linkedin.com/in/john-i-doherty) [![Twitter Follow](https://img.shields.io/twitter/follow/CambridgeMVP.svg?style=social&label=Twitter&style=plastic)](https://twitter.com/CambridgeMVP)
1+
# selenium-cucumber-js [![Shippable branch](https://img.shields.io/shippable/5818b23bbd56670e00037040/master.svg)](https://app.shippable.com/projects/5818b23bbd56670e00037040) [![npm](https://img.shields.io/npm/dt/selenium-cucumber-js.svg)](https://www.npmjs.com/package/selenium-cucumber-js)
42

53
JavaScript browser automation framework using official [selenium-webdriver](http://seleniumhq.github.io/selenium/docs/api/javascript/ "view webdriver js documentation") and [cucumber-js](https://github.com/cucumber/cucumber-js "view cucumber js documentation").
64

@@ -14,6 +12,7 @@ JavaScript browser automation framework using official [selenium-webdriver](http
1412
* [Step definitions](#step-definitions)
1513
* [Page objects](#page-objects)
1614
* [Shared objects](#shared-objects)
15+
* [Visual Comparison](#visual-comparison)
1716
* [Before/After hooks](#beforeafter-hooks)
1817
* [Reports](#reports)
1918
* [How to debug](#how-to-debug)
@@ -234,12 +233,11 @@ module.exports = function () {
234233
};
235234
```
236235

237-
### Applitools Eyes!
238-
The Applitools Eyes Selenium JavaScript SDK allows you to easily add visual checkpoints to your JavaScript Selenium tests.
239-
It takes care of getting screenshots of your application from the underlying WebDriver, sending them to the Eyes server for validation and failing the test in case differences are found.
240-
To use Applitools Eyes specifying an ApiKey from Aplitools using a `selenium-cucumber-js.json` file at the root of your project
236+
### Visual Comparison
237+
238+
The `selenium-cucumber-js` framework uses [Applitools Eyes](https://applitools.com/) to add visual checkpoints to your JavaScript Selenium tests. It takes care of getting screenshots of your application from the underlying WebDriver, sending them to the Applitools Eyes server for validation and failing the test when differences are detected. To preform visual comparisons within your tests, obtain an [Applitools Eyes](https://applitools.com/) API Key and assign it to the `eye_key` property of the `selenium-cucumber-js.json` config file in the root of your project.
241239

242-
For example the following configuration could be used with an increased timeout which allows enough time for viusual checks:
240+
For example the following configuration could be used with an increased timeout which allows enough time for visual checks:
243241

244242
```json
245243
{
@@ -260,7 +258,6 @@ module.exports = {
260258
searchResultLink: by.css('div.g > h3 > a')
261259
},
262260

263-
264261
applitools_Eyes_Example: function () {
265262

266263
// Start the test and set the browser's viewport size to 800x600.
@@ -285,7 +282,6 @@ module.exports = {
285282
};
286283
```
287284

288-
289285
### Before/After hooks
290286

291287
You can register before and after handlers for features and scenarios:

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "selenium-cucumber-js",
3-
"version": "1.4.10",
3+
"version": "1.5.0",
44
"description": "JavaScript browser automation framework using official selenium-webdriver and cucumber-js",
55
"main": "index.js",
66
"scripts": {
@@ -179,4 +179,4 @@
179179
]
180180
}
181181
}
182-
}
182+
}

0 commit comments

Comments
 (0)