Skip to content

Commit 7286284

Browse files
authored
docs: Add Docker image as installation option in README (#150)
1 parent 097fbba commit 7286284

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,15 @@ It is possible to build platform specific binaries for Linux, MacOS, and Windows
6464

6565
To build these, run `npm run pkg` in the root. The binaries (lint-openapi-linux, lint-openapi-macos, lint-openapi-windows.exe respectively) are built in the 'bin' directory in the root.
6666

67+
### Docker container
68+
A community Docker image is [publicly available on Docker hub](https://hub.docker.com/r/jamescooke/openapi-validator).
69+
70+
`docker pull jamescooke/openapi-validator`
71+
72+
Once pulled, the container can be run directly, but mount a volume containing the OpenAPI specification file so that it can be accessed.
73+
74+
`docker run --volume "$PWD":/data jamescooke/openapi-validator [options] [command] [<files>]`
75+
6776
## Usage
6877
### Command line
6978
`lint-openapi [options] [command] [<files>]`

0 commit comments

Comments
 (0)