11# Java SDK for [ Visual Regression Tracker] ( https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker )
22[ ![ Codacy Badge] ( https://app.codacy.com/project/badge/Grade/79dcd96f2be04992bc1059cad60e2e04 )] ( https://www.codacy.com/gh/Visual-Regression-Tracker/sdk-java?utm_source=github.com& ; utm_medium=referral& ; utm_content=Visual-Regression-Tracker/sdk-java& ; utm_campaign=Badge_Grade )
3+
34## Gradle
5+
46``` yml
57repositories {
68 maven { url 'https://jitpack.io' }
79}
810```
11+
912``` yml
1013dependencies {
1114 implementation group : ' com.github.visual-regression-tracker' , name: 'sdk-java', version: '${REPLACE_THIS_VALUE}'
1215}
1316```
17+
1418## Maven
19+
1520``` xml
1621<repositories >
1722 <repository >
@@ -20,6 +25,7 @@ dependencies {
2025 </repository >
2126</repositories >
2227```
28+
2329``` xml
2430<dependency >
2531 <groupId >com.github.Visual-Regression-Tracker</groupId >
@@ -32,7 +38,9 @@ dependencies {
3238More info about https://jitpack.io/
3339
3440## Usage
41+
3542* Create config
43+
3644``` java
3745VisualRegressionTrackerConfig config = new VisualRegressionTrackerConfig (
3846 // apiUrl - URL where backend is running
@@ -45,28 +53,39 @@ VisualRegressionTrackerConfig config = new VisualRegressionTrackerConfig(
4553 " F5Z2H0H2SNMXZVHX0EA4YQM1MGDD" ,
4654
4755 // branch - Current git branch
48- " develop"
56+ " develop" ,
57+
58+ // enableSoftAssert - Log errors instead of exceptions
59+ false
4960);
5061```
62+
5163* Create an instance of ` VisualRegressionTracker `
64+
5265``` java
5366VisualRegressionTracker visualRegressionTracker = new VisualRegressionTracker (config);
5467```
68+
5569* Take a screenshot as String in Base64 format
70+
5671``` java
5772// Selenium example
5873String screenshotBase64 = ((TakesScreenshot ) driver). getScreenshotAs(OutputType . BASE64 );
5974```
75+
6076* Track image
6177
6278Default options
79+
6380``` java
6481visualRegressionTracker. track(
6582 " Name for test" ,
6683 screenshotBase64
6784);
6885```
86+
6987With specific options
88+
7089``` java
7190visualRegressionTracker. track(
7291 " Name for test" ,
0 commit comments