Skip to content

docs: use full Docker hub image name #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 18, 2018
Merged

docs: use full Docker hub image name #41

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1d0334
docs: use full Docker hub image name
itsjavi Apr 18, 2018
ffd842d
Update README.md
itsjavi Apr 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,18 @@ Available on [Maven Central](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%2

# Docker

Available on [Docker Hub](https://hub.docker.com/r/quen2404/openapi-diff/)
Available on [Docker Hub](https://hub.docker.com/r/quen2404/openapi-diff/) as `quen2404/openapi-diff`.

## Build image
## Build the image

This is only required if you want to try new changes in the Dockerfile of this project.

```bash
docker build -t openapi-diff .
docker build -t local-openapi-diff .
```

You can replace the local image name `dev-openapi-diff` by any name of your choice.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replace dev-openapi-diff by local-openapi-diff to be coherent :)

Copy link
Contributor Author

@itsjavi itsjavi Apr 18, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot that one, it should be fixed now :)


## Run an instance

In this example the `$(pwd)/src/test/resources` directory is mounted in the `/specs` directory of the container
Expand All @@ -44,9 +48,11 @@ in readonly mode (`ro`).
```bash
docker run -t \
-v $(pwd)/src/test/resources:/specs:ro \
openapi-diff /specs/path_1.yaml /specs/path_2.yaml
quen2404/openapi-diff /specs/path_1.yaml /specs/path_2.yaml
```

The remote name `quen2404/openapi-diff` can be replaced with `local-openapi-diff` or the name you gave to your local image.

# Usage
OpenDiff can read swagger api spec from json file or http.

Expand Down