update README.md

viktor-silakov · Apr 13, 2022 · 9c123d0 · 9c123d0
1 parent 16728a3
commit 9c123d0
Showing 1 changed file with 27 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # WDIO Syngrisi Cucumber Service
 
-The service helps integrate [WebdriverIO](https://webdriver.io/) test framework and [Syngrisi](https://github.com/viktor-silakov/syngrisi) visual testing tool.
+The service helps integrate [WebdriverIO](https://webdriver.io/) test framework
+and [Syngrisi](https://github.com/viktor-silakov/syngrisi) visual testing tool.
 
 ## Installation
 
@@ -15,35 +16,37 @@ In order to use the service with WebdriverIO test runner add these settings to s
 ```js
 // wdio.conf.js
 export.config = {
-  // ...
-  services: [
-                'syngrisi-cucumber',
-                {
-                    // syngrisi server endpoint
-                    endpoint: `http://localhost:3000/`,
-                    // syngrisi API key
-                    apikey: process.env['SYNGRISI_API_KEY'] || '',
-                    // project name
-                    project: 'My Project',
-                    // the tested branch
-                    branch: 'master',
-                    // run name (will be auto generated if not present)
-                    runname: process.env['RUN_NAME'],
-                    // run name (will be auto generated if not present)
-                    runident: process.env['RUN_IDENT'],
-                    // tag for visual regression scenarios
-                    // for all scenarios with this tag the service will create session on syngrisi
-                    // if tag is empty the visual session will be created for all scenarios
-                    // tag: '@visual',
-                },
-            ],
-  // ...
+    // ...
+    services: [
+        ['syngrisi-cucumber',
+            {
+                // syngrisi server endpoint
+                endpoint: `http://localhost:3000/`,
+                // syngrisi API key
+                apikey: process.env['SYNGRISI_API_KEY'] || '',
+                // project name
+                project: 'My Project',
+                // the tested branch
+                branch: 'master',
+                // run name (will be auto generated if not present)
+                runname: process.env['RUN_NAME'],
+                // run name (will be auto generated if not present)
+                runident: process.env['RUN_IDENT'],
+                // tag for visual regression scenarios
+                // for all scenarios with this tag the service will create session on syngrisi
+                // if tag is empty the visual session will be created for all scenarios
+                // tag: '@visual',
+            }
+        ],
+    ],
+    // ...
 };
 ```
 
 ## Usage
 
 After all the preparations, you can use the `browser.syngrisiCheck(checkName, imageBuffer)` method in which:
+
 * `checkName` - the name of the check in Syngrisi
 * `imageBuffer` - the screenshot image buffer