From 77c792a9185bcfb34fb9c2205e7e357e73463ee0 Mon Sep 17 00:00:00 2001 From: Martin Hansen Date: Fri, 20 Sep 2024 09:42:07 +0200 Subject: [PATCH] docs: slightly easier README commit-id:6e1d2694 --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4348ec5..dcbe55e 100644 --- a/README.md +++ b/README.md @@ -34,24 +34,21 @@ NORDIGEN_SECRET_KEY= EOT ``` -All valid config options can be found in the [config.go](config.go) file. +_All valid config options can be found [here](https://pkg.go.dev/github.com/martinohansen/ynabber#Config)_ -To read the environment variables from a file and run the binary one can use the -[declare](https://www.gnu.org/software/bash/manual/bash.html#index-declare) -command: +Once the environment variables are set, run the binary: ```bash -# Read environment variables from file and run ynabber -declare $(cat ynabber.env); ynabber +# Read environment variables from file first +set -a; . ./ynabber.env; set +a; ynabber +ynabber ``` -Or run the container and parse in the variables with -[Docker](https://docs.docker.com/engine/reference/run/) +Or run in a container with +[Docker](https://docs.docker.com/engine/reference/run/): -```bash -docker run --env-file=ynabber.env ghcr.io/martinohansen/ynabber:latest -# To keep data persistent +```bash docker run \ --volume ${PWD}:/data \ --env 'YNABBER_DATADIR=/data' \