Skip to content

Commit

Permalink
Update readme with how to include oq into docker image (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
Blacksmoke16 authored Dec 29, 2019
1 parent 56b451e commit dadc25d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,20 @@ shards build --production

The built binary will be available as `./bin/oq`. This can be relocated elsewhere on your machine; be sure it is in your `PATH` to access it as `oq`.

### Docker

`oq` can easily be included into a Docker image by fetching the static binary from Github for the version of `oq` that you want.

```dockerfile
# Set an arg to store the oq version that should be installed.
ARG OQ_VERSION=1.0.0

# Grab the binary from the latest Github release and make it executable; placing it within /usr/local/bin. Can also put it elsewhere if you so desire.
RUN wget https://github.com/Blacksmoke16/oq/releases/download/v${OQ_VERSION}/oq-${OQ_VERSION}-linux-x86_64 -O /usr/local/bin/oq && chmod +x /usr/local/bin/oq

# Also be sure to install jq if it is not already!
```

## Usage

### CLI
Expand Down

0 comments on commit dadc25d

Please sign in to comment.