Skip to content

Commit 2d6428a

Browse files
itdependsnetworkspszulczewskiscetron
authored
Apply suggestions from code review
Co-authored-by: Patryk Szulczewski <[email protected]> Co-authored-by: Stephen Corry <[email protected]>
1 parent 2ef0ee0 commit 2d6428a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Our primary use case is the examination of structured data returned from network
77
* Compare the operational state of network devices pre and post change
88
* Compare operational state of a device vs a "known healthy" state
99
* Compare state of similar devices, such as a pair of leafs or a pair of backbone routers
10+
* Compare operational state of a component (interface, vrf, bgp peering, etc.) migrated from one device to another
1011

1112
However, the library fits other use cases where structured data needs to be operated on.
1213

@@ -24,14 +25,14 @@ The library provides the ability to ask more intelligent questions of a given da
2425

2526
* Is the route table within 10% of routes before and after a change?
2627
* Is all of the interfaces that were up before the change, still up?
27-
* Is there at least 10k sessions of traffic on my firewall?
28+
* Are there at least 10k sessions of traffic on my firewall?
2829
* Is there there at least 2 interfaces up within lldp neighbors?
2930

3031
## Technical Overview
3132

3233
The library heavily relies on [JMESPath](https://jmespath.org/) for traversing the JSON object and finding the values to be evaluated. More on that [here](#customized-jmespath).
3334

34-
`jdiff` has been developed around diffing and testing structured data returned from APIs and other Python modules and libraries (such as TextFSM) but is equally useful when working or dealing with data returned from APIs.
35+
`jdiff` has been developed around diffing and testing structured data returned from Network APIs and libraries (such as TextFSM) but is equally useful when working or dealing with data returned from APIs.
3536

3637
## Documentation
3738

0 commit comments

Comments
 (0)