diff --git a/README.md b/README.md index 28cc474..1760042 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,15 @@ Python versions License CI - Coverage

ConfigDiff compares structured config files **semantically** -- parsing JSON, YAML, TOML, and INI into normalised trees and performing recursive deep comparison. It detects added, removed, modified, and type-changed values at any depth, then produces clean human-readable output for terminal review or machine-readable JSON/YAML for CI/CD pipelines. +

+ ConfigDiff showing semantic configuration changes in a terminal +

+ ``` $ configdiff before.yaml after.yaml diff --git a/docs/configdiff-demo.svg b/docs/configdiff-demo.svg new file mode 100644 index 0000000..8f259a2 --- /dev/null +++ b/docs/configdiff-demo.svg @@ -0,0 +1,25 @@ + + ConfigDiff terminal demonstration + A terminal showing added and modified configuration values from a semantic comparison. + + + + + configdiff + + $ configdiff before.yaml after.yaml + Found 5 changes: 2 added, 3 modified + ~ bgp.neighbors[0].remote_as + 65001 + → + 65010 + ~ interfaces.GigabitEthernet0/1.enabled + true + → + false + + interfaces.GigabitEthernet0/2 + ip: 172.16.0.1 · enabled: true + + ntp.servers[1]: pool.ntp.org + + Structure-aware · CI-friendly + diff --git a/docs/social-preview.png b/docs/social-preview.png new file mode 100644 index 0000000..f11da7b Binary files /dev/null and b/docs/social-preview.png differ