From 899b1f1c811becc464308a06efbb9b264723c22f Mon Sep 17 00:00:00 2001 From: Sebastian Mark Date: Thu, 21 Dec 2023 19:15:58 +0100 Subject: [PATCH] doc: update config file help and reorder options --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a9c3677..8803808 100644 --- a/README.md +++ b/README.md @@ -23,15 +23,15 @@ See `requirements.txt` See `dc-ops --help` ## Configuration Options -- `self-update`: (optional) update this script on startup. Defaults to `false`. -- `loglevel`: (optional) define loglevel. Defaults to "INFO" if not set. -- `compose-opts`: (optional) define additional parameters to `docker compose up -d`. - `stacks`: an array containing details for each repository. Each element is a dictionary containing the following keys: - `dir`: the directory of the repository on your local machine. - `compose-files`: (optional) array of paths (relative to `dir`) to docker-compose files. Uses `["docker-compose.yml"]` by default if not set. - `enabled`: (optional) `false` if this repository should be skipped. Defaults to `true` if not set. - - `pre`: (optional) a command to be run before `docker-compose up`, executed in `dir`. - - `post`: (optional) a command to be run after `docker-compose up`, executed in `dir`. + - `pre`: (optional) a command to be run before `docker compose up`, executed in `dir`. + - `post`: (optional) a command to be run after `docker compose up`, executed in `dir`. +- `compose-opts`: (optional) define additional parameters to `docker compose up -d`. +- `loglevel`: (optional) define loglevel. Defaults to "INFO" if not set. +- `self-update`: (optional) update this script on startup. Defaults to `false`. ## Detailed process For each enabled stack in the config file, the following process will be executed: