Skip to content

Commit ae961f9

Browse files
committed
updated
1 parent 9e2fdd5 commit ae961f9

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
# compose_diff
77

88
Diff docker-compose files.
9+
When deploying using docker-compose, these files could be used to generate Release Notes.
10+
Especially interesting is to diff two docker-compose Releases by each other, then customers know the changed components and testers know which part to especially test.
911

1012
## Usage
1113

@@ -16,9 +18,15 @@ Install it via:
1618

1719
After that use it like
1820

19-
`compose_diff --images old.yml new.yml`
20-
this will print the the differences in the used images between the two versions.
21+
`compose_diff --versions old.yml new.yml`
22+
this will print the differences in the used versions/tags between the two compose files.
23+
24+
`compose_diff --instances old.yml new.yml`
25+
this will print the amount of instances of this image between the two compose files.
2126

2227
## Features
28+
2329
- Support for Version 2 and Version 1.
24-
- Diffs Images
30+
- Diffs Image Versions
31+
- Diffs Image Instances
32+
- Output in Markdown and CSV format

0 commit comments

Comments
 (0)