ReadMe dotnet for v3.0.1 (#121)

percy · Oct 26, 2023 · ac36ef6 · ac36ef6
1 parent 8eb2ff2
commit ac36ef6
Showing 1 changed file with 36 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -180,24 +180,46 @@ class Program
 - `driver` (**required**) - A appium driver instance
 - `name` (**required**) - The screenshot name; must be unique to each screenshot
 - `options` (**optional**) - There are various options supported by percy_screenshot to server further functionality.
-    - `freezeAnimation` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations.
+    - `freezeAnimatedImage` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations.
+    - `freezeImageBySelectors` - List of selectors. Images will be freezed which are passed using selectors. For this to work `freezeAnimatedImage` must be set to true.
+    - `freezeImageByXpaths` - List of xpaths. Images will be freezed which are passed using xpaths. For this to work `freezeAnimatedImage` must be set to true.
     - `percyCSS` - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken.
-    - `ignoreRegionXpaths` - elements in the DOM can be ignored using xpath
-    - `ignoreRegionSelectors` - elements in the DOM can be ignored using selectors.
-    - `ignoreRegionAppiumElements` - elements can be ignored using appium_elements.
-    - `customIgnoreRegions` - elements can be ignored using custom boundaries
-      - IgnoreRegion:-
-        - Description: This class represents a rectangular area on a screen that needs to be ignored for visual diff.
-
-        - Constructor:
+    - `ignoreRegionXpaths` - List of xpaths. elements in the DOM can be ignored using xpath
+    - `ignoreRegionSelectors` - List of selectors. elements in the DOM can be ignored using selectors.
+    - `ignoreRegionAppiumElements` - List of appium web-element. elements can be ignored using appium_elements.
+    - `customIgnoreRegions` - List of custom objects. elements can be ignored using custom boundaries. Just passing a simple object for it like below.
+      - Refer to example -
+        - ```
+          List<object> ignoreCustomElement = new List<object>();
+          var region1 = new Dictionary<string, int>();
+          region1.Add("top", 10);
+          region1.Add("bottom", 120);
+          region1.Add("right", 10);
+          region1.Add("left", 10);
+          ignoreCustomElement.Add(region1);
+          region1.Add("custom_ignore_regions", ignoreCustomElement);
           ```
-          init(self, top, bottom, left, right)
+    - `considerRegionXpaths` - List of xpaths. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using xpaths.
+    - `considerRegionSelectors` - List of selectors. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using selectors.
+    - `considerRegionAppiumElements` - List of appium web-element. elements can be considered for diffing and will be ignored by Intelli Ignore using appium_elements.
+    - `customConsiderRegions` - List of custom objects. elements can be considered for diffing and will be ignored by Intelli Ignore using custom boundaries
+      - Refer to example -
+        - ```
+          List<object> considerCustomElement = new List<object>();
+          var region2 = new Dictionary<string, int>();
+          region2.Add("top", 10);
+          region2.Add("bottom", 120);
+          region2.Add("right", 10);
+          region2.Add("left", 10);
+          considerCustomElement.Add(region2);
+          region2.Add("custom_consider_regions", considerCustomElement);
           ```
         - Parameters:
-          `top` (int): Top coordinate of the ignore region.
-          `bottom` (int): Bottom coordinate of the ignore region.
-          `left` (int): Left coordinate of the ignore region.
-          `right` (int): Right coordinate of the ignore region.
+          - `top` (int): Top coordinate of the consider region.
+          - `bottom` (int): Bottom coordinate of the consider region.
+          - `left` (int): Left coordinate of the consider region.
+          - `right` (int): Right coordinate of the consider region.
+
 ### Creating Percy on automate build
 Note: Automate Percy Token starts with `auto` keyword. The command can be triggered using `exec` keyword.
 ```sh-session