Skip to content

Commit 4db6805

Browse files
committed
add workflow diagram
1 parent 00ed93f commit 4db6805

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@ This library is meant to be a light-weight way to compare structured output from
44

55
The library heavily relies on [jmespath](https://jmespath.org/) for traversing the json object and finding the value(s) to be evaluated. More on that later.
66

7+
78
## Use Case
89

910
`netcompare` enables an easy and direct way to see the outcome of network configuration or operational status change. The intended usage is to collect structured `show` command output before and after a change window. Prior to closing the change window, the results are compared to help determine if the change was successful as intended and if the network is in an acceptable state. The output can be stored with the change's documentation for easy reference and proof of completion.
1011

12+
## Workflow
13+
14+
![netcompare workflow](./docs/images/workflow.png)
15+
16+
1117
## Library Architecture
1218

1319
![netcompare HLD](./docs/images/hld.png)

docs/images/workflow.png

61.1 KB
Loading

0 commit comments

Comments
 (0)