From f56965abc2872096f1e92686caf24fa2db5e4e22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matej=20Jane=C5=BEi=C4=8D?= Date: Wed, 27 Nov 2024 18:43:33 +0100 Subject: [PATCH] chore: add completion and configuration to readme --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8d38ece..666ee6a 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,25 @@ # ahab -## Installing +## installing -Clone this repo, with rust installed run this from root of the repo. - -``` +You will need rust installed. Clone repo and run: +```bash cargo install --path . ``` -For printing of underlying commands install with `debug` flag. - -``` +To print underlying commands build with `debug` flag. +```bash cargo install --path . --debug ``` + +## shell completion + +Completion files are generated **during build process** in `target/*/build/*/out/*`. Depending on your shell of choice move generated file to correct place in you file system. + +## configuration + +Currently `ahab` respects three environment variables. + +- `COMPOSE_FILE`: control which docker-compose file is used - defaults to `docker/local/docker-compose.yaml` +- `AHAB_POSTGRES_CONATINER`: control which compose service is used for sending postgres commands - defaults to `postgresdb` +- `AHAB_POSTGRES_CONATINER`: control which compose service is used for sending django commands - defaults to `appserver`