From 8bf2d2a247ec999610fa75624d1bd600895afbbd Mon Sep 17 00:00:00 2001 From: Peter Hallam Date: Mon, 8 May 2023 14:43:47 +0800 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 69e4312..7669eeb 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,15 @@ Documentation for each subcommand: Using Docker links to `postgres` container. This will display the usage information: -```docker run --rm -i -t --link myserver:postgres docker.io/panubo/postgres-toolbox``` +```console +docker run --rm -i -t --link myserver:postgres docker.io/panubo/postgres-toolbox +``` To run the subcommand: -```docker run --rm -i -t --link myserver:postgres docker.io/panubo/postgres-toolbox ``` +```console +docker run --rm -i -t --link myserver:postgres docker.io/panubo/postgres-toolbox +``` ## Configuration @@ -31,10 +35,12 @@ Use `--link :postgres` to automatically specify the req Or alternatively specify the environment variables: -- `DATABASE_HOST` = IP / hostname of PostgreSQL server. -- `DATABASE_PORT` = TCP Port of PostgreSQL service. -- `DATABASE_USER` = Administrative user eg postgres with SUPERUSER privileges. -- `DATABASE_PASS` = Password of administrative user. +| Name | Description | +| --- | --- | +| `DATABASE_HOST` | IP / hostname of PostgreSQL server. | +| `DATABASE_PORT` | TCP Port of PostgreSQL service. | +| `DATABASE_USER` | Administrative user eg postgres with SUPERUSER privileges. | +| `DATABASE_PASS` | Password of administrative user. | Some subcommands require additional environment parameters. @@ -42,7 +48,7 @@ Some subcommands require additional environment parameters. [bats](https://bats-core.readthedocs.io/en/stable/index.html) is used for testing. To test the image and commands bats and docker are required. Use the following commands to run all of the tests. -``` +```console make build-with-cache # or make build make test ```