Skip to content

Commit 8bf2d2a

Browse files
committed
Update README.md
1 parent 8a4992b commit 8bf2d2a

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -19,30 +19,36 @@ Documentation for each subcommand:
1919

2020
Using Docker links to `postgres` container. This will display the usage information:
2121

22-
```docker run --rm -i -t --link myserver:postgres docker.io/panubo/postgres-toolbox```
22+
```console
23+
docker run --rm -i -t --link myserver:postgres docker.io/panubo/postgres-toolbox
24+
```
2325

2426
To run the subcommand:
2527

26-
```docker run --rm -i -t --link myserver:postgres docker.io/panubo/postgres-toolbox <subcommand>```
28+
```console
29+
docker run --rm -i -t --link myserver:postgres docker.io/panubo/postgres-toolbox <subcommand>
30+
```
2731

2832
## Configuration
2933

3034
Use `--link <postgres container name>:postgres` to automatically specify the required variables.
3135

3236
Or alternatively specify the environment variables:
3337

34-
- `DATABASE_HOST` = IP / hostname of PostgreSQL server.
35-
- `DATABASE_PORT` = TCP Port of PostgreSQL service.
36-
- `DATABASE_USER` = Administrative user eg postgres with SUPERUSER privileges.
37-
- `DATABASE_PASS` = Password of administrative user.
38+
| Name | Description |
39+
| --- | --- |
40+
| `DATABASE_HOST` | IP / hostname of PostgreSQL server. |
41+
| `DATABASE_PORT` | TCP Port of PostgreSQL service. |
42+
| `DATABASE_USER` | Administrative user eg postgres with SUPERUSER privileges. |
43+
| `DATABASE_PASS` | Password of administrative user. |
3844

3945
Some subcommands require additional environment parameters.
4046

4147
## Testing
4248

4349
[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.
4450

45-
```
51+
```console
4652
make build-with-cache # or make build
4753
make test
4854
```

0 commit comments

Comments
 (0)