Fix README.md with example

VolumeGraphics · Oct 5, 2023 · 1fc2c77 · 1fc2c77
1 parent 3c7507f
commit 1fc2c77
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -226,8 +226,28 @@ rules:
         - "--only-images"
 ```
 
+
+#### JSON comparison
+Compares JSON files for different keys in both files and mismatches in values.
+ignore_keys elements will be ignored, no substring or regex is supported here. 
+If you need this, please file a bug.
+
+```yaml
+rules:
+- name: "Compare JSON files"
+  pattern_include:
+  - "**/*.json"
+  Json:
+    ignore_keys:
+    - ""
+```
+
+
 ## Changelog
 
+### 0.5.0
+- Add basic JSON checking
+
 ### 0.4.0
 - Separate reporting logic from comparison logic
 - Implement a machine-readable JSON reporting