Skip to content

Commit 7b1935e

Browse files
committed
Update REAME.md with docker info
1 parent ad4e292 commit 7b1935e

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,27 @@ Available on [Maven Central](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%2
2626
</dependency>
2727
```
2828

29+
# Docker
30+
31+
Available on [Docker Hub](https://hub.docker.com/r/quen2404/openapi-diff/)
32+
33+
## Build image
34+
35+
```bash
36+
docker build -t openapi-diff .
37+
```
38+
39+
## Run an instance
40+
41+
In this example the `$(pwd)/src/test/resources` directory is mounted in the `/specs` directory of the container
42+
in readonly mode (`ro`).
43+
44+
```bash
45+
docker run -t \
46+
-v $(pwd)/src/test/resources:/specs:ro \
47+
openapi-diff /specs/path_1.yaml /specs/path_2.yaml
48+
```
49+
2950
# Usage
3051
OpenDiff can read swagger api spec from json file or http.
3152

@@ -274,24 +295,6 @@ try {
274295
Changed response : [200] //successful operation
275296
```
276297

277-
# Docker
278-
279-
## Build image
280-
```bash
281-
docker build -t openapi-diff .
282-
```
283-
284-
## Run an instance
285-
286-
In this example the `$(pwd)/src/test/resources` directory is mounted in the `/specs` directory of the container
287-
in readonly mode (`ro`).
288-
289-
```bash
290-
docker run -t \
291-
-v $(pwd)/src/test/resources:/specs:ro \
292-
openapi-diff /specs/path_1.yaml /specs/path_2.yaml
293-
```
294-
295298
# License
296299
openapi-diff is released under the Apache License 2.0.
297300

0 commit comments

Comments
 (0)