Skip to content
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

Jump to bottom

docs: remove link to external docker image #599

Merged
merged 1 commit into from
May 24, 2023
Merged

docs: remove link to external docker image #599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 1 addition & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The IBM OpenAPI Validator lets you validate OpenAPI 3.x documents according to t

You should regenerate the TOC after making changes to this file.

markdown-toc --maxdepth 5 -i README.md
npm run format-readme-toc
-->

<!-- toc -->
Expand All @@ -34,7 +34,6 @@ The IBM OpenAPI Validator lets you validate OpenAPI 3.x documents according to t
* [Download an executable binary](#download-an-executable-binary)
* [Build from source](#build-from-source)
+ [Build platform-specific binaries](#build-platform-specific-binaries)
* [Docker container](#docker-container)
- [Usage](#usage)
* [Command Syntax](#command-syntax)
* [Configuration](#configuration)
Expand Down Expand Up @@ -104,15 +103,6 @@ _If you installed the validator using `npm install -g ibm-openapi-validator`, yo
#### Build platform-specific binaries
It is also possible to build platform specific binaries from the source code by running `npm run pkg` in the project root directory. The binaries (lint-openapi-macos, lint-openapi-linux, lint-openapi-windows.exe) will be in the project's `packages/validator/bin` directory.

### Docker container
A community Docker image is [publicly available on Docker hub](https://hub.docker.com/r/jamescooke/openapi-validator).

`docker pull jamescooke/openapi-validator`

Once pulled, the container can be run directly, but mount a volume containing the OpenAPI specification file so that it can be accessed.

`docker run --volume "$PWD":/data jamescooke/openapi-validator [options] [command] [<files>]`

## Usage
### Command Syntax
```bash
Expand Down