From e2b54d5e88c29aa6e7fcf6a2e5c4df26ef8eb169 Mon Sep 17 00:00:00 2001
From: Paul Gabriel <pgabriel@37signals.com>
Date: Thu, 20 Jun 2024 12:03:04 +0200
Subject: [PATCH] doc: Update README

---
 README.md | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 9ab3796..fd2ef8a 100644
--- a/README.md
+++ b/README.md
@@ -12,37 +12,37 @@ $ docker run -it --rm ghcr.io/dataforgoodfr/d4g-s3-backup:latest --help
 USAGE docker run -it --rm -v /var/data:/data -v /opt/backups:/backups ghcr.io/dataforgoodfr/d4g-s3-backup \
   [--access-key="<access_key>"] \
   [--secret-key="<secret_key>"] \
+  [--backups-dir="/backups"] \
   [--bucket-name="backups"] \
-  [--host-base="%(bucket)s.s3.fr-par.scw.cloud"] \
+  [--bucket-region="fr-par"] \
   [--data-dir="/data"] \
-  [--backups-dir="/backups"] \
-  [--service-name="service"] \
+  [--host-base="%(bucket)s.s3.fr-par.scw.cloud"] \
+  [--prom-metrics] \
   [--retention-days=30] \
-  [--bucket-region="fr-par"] \
+  [--service-name="service"] \
   [--debug] \
   [--help]
 
 Create backups for a specific dir easily and sync them to an s3 compatible bucket.
-This script also supports publishing prometheu-compatible metrics through the Textfile Collector.
 
-Data from <data_dir> will be backed up to <backups-dir>/<service-name>/<service-name>-2024-06-19.tar.gz
+Data from <data_dir> will be backed up to <backups-dir>/<service-name>/<service-name>-2024-06-20.tar.gz
 Files will be keps around for <retention-days> days.
 Files will be synced to s3 under s3://<bucket-name>/<service-name> using supplied credentials and configuration.
 
 Supported parameters :
 -h, --help : display this message
---debug : Print configuration before running (Optional, also set by environment variable DEBUG)
---access-key : AWS access key (Required, also set by environment variable ACCESS_KEY)
---secret-key : AWS secret key (Required, also set by environment variable SECRET_KEY)
+--access-key : AWS-format access key (Required, also set by environment variable ACCESS_KEY)
+--secret-key : AWS-format secret key (Required, also set by environment variable SECRET_KEY)
+--backups-dir : backups root directory where will be stored (Optional, Default /opt/backups/, also set by environment variable BACKUPS_DIR)
 --bucket-name : name of the bucket to sync backups to (Optional, Default backups, also set by environment variable BUCKET_NAME)
+--bucket-region : S3 bucket region (Optional, Default fr-par, also set by environment variable BUCKET_REGION)
 --data-dir : directory to backup (Optional, Default ./data, also set by environment variable DATA_DIR)
---service-name : name of the service to backup (Optional, Default service, also set by environment variable SERVICE_NAME)
---backups-dir : backups root directory where will be stored (Optional, Default /opt/backups/, also set by environment variable BACKUPS_DIR)
---host-bucket : Bucket host base (Optional, Default ${BUCKET_NAME}s.s3.fr-par.scw.cloud, also set by environment variable HOST_BUCKET)
 --host-base : S3 host base (Optional, Default %(bucket)s.s3.fr-par.scw.cloud, also set by environment variable HOST_BASE)
---bucket-region : S3 bucket region (Optional, Default fr-par, also set by environment variable BUCKET_REGION)
---retention-days : number of days to keep backups (Default 30, also set by environment variable RETENTION_DAYS)
+--host-bucket : Bucket host base (Optional, Default ${BUCKET_NAME}s.s3.fr-par.scw.cloud, also set by environment variable HOST_BUCKET)
+--prom-metrics : enable prometheus metrics (Optional, Default false, also set by environment variable PROM_METRICS)
 --prune : prune backups older than retention-days on remote s3 bucket (Optional, Default false, also set by environment variable PRUNE)
+--retention-days : number of days to keep backups (Default 30, also set by environment variable RETENTION_DAYS)
+--service-name : name of the service to backup (Optional, Default service, also set by environment variable SERVICE_NAME)
 ```
 
 ### Example